openapi: 3.0.3
info:
title: Cloudflare / Accounts API
description: Needs description.
license:
name: BSD-3-Clause
url: https://opensource.org/licenses/BSD-3-Clause
version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
description: Client API
security:
- api_email: []
api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Accounts
paths:
/accounts/{account_id}:
get:
tags:
- Accounts
summary: Cloudflare Account Details
description: Get information about a specific account that you are a member of.
operationId: accounts-account-details
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_schemas-identifier'
responses:
'200':
description: Account Details response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_response_single'
4XX:
description: Account Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Account
description: Update an existing account.
operationId: accounts-update-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/iam_components-schemas-account'
responses:
'200':
description: Update Account response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_response_single'
4XX:
description: Update Account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/address_maps:
get:
tags:
- Accounts
summary: Cloudflare List Address Maps
description: List all address maps owned by the account.
operationId: ip-address-management-address-maps-list-address-maps
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: List Address Maps response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_components-schemas-response_collection'
4XX:
description: List Address Maps response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_components-schemas-response_collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Address Map
description: Create a new address map under the account.
operationId: ip-address-management-address-maps-create-address-map
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
description:
$ref: '#/components/schemas/addressing_schemas-description'
enabled:
$ref: '#/components/schemas/addressing_enabled'
responses:
'200':
description: Create Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_full_response'
4XX:
description: Create Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_full_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/address_maps/{address_map_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Address Map
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:
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Delete Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Address Map Details
description: Show a particular address map owned by the account.
operationId: ip-address-management-address-maps-address-map-details
parameters:
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Address Map Details response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_full_response'
4XX:
description: Address Map Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_full_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update Address Map
description: Modify properties of an address map owned by the account.
operationId: ip-address-management-address-maps-update-address-map
parameters:
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
default_sni:
$ref: '#/components/schemas/addressing_default_sni'
description:
$ref: '#/components/schemas/addressing_schemas-description'
enabled:
$ref: '#/components/schemas/addressing_enabled'
responses:
'200':
description: Update Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_components-schemas-single_response'
4XX:
description: Update Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_components-schemas-single_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}:
delete:
tags:
- Accounts
summary: Cloudflare Remove an account membership from an Address Map
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Remove an account membership from an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Remove an account membership from an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Add an account membership to an Address Map
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Add an account membership to an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Add an account membership to an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}:
delete:
tags:
- Accounts
summary: Cloudflare Remove an IP from an Address Map
description: Remove an IP from a particular address map.
operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map
parameters:
- name: ip_address
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_ip_address'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Remove an IP from an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Remove an IP from an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Add an IP to an Address Map
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:
- name: ip_address
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_ip_address'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Add an IP to an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Add an IP to an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}:
delete:
tags:
- Accounts
summary: Cloudflare Remove a zone membership from an Address Map
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:
- name: zone_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Remove a zone membership from an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Remove a zone membership from an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Add a zone membership to an Address Map
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:
- name: zone_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: address_map_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Add a zone membership to an Address Map response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Add a zone membership to an Address Map response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/loa_documents:
post:
tags:
- Accounts
summary: Cloudflare Upload LOA Document
description: Submit LOA document (pdf format) under the account.
operationId: ip-address-management-prefixes-upload-loa-document
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- loa_document
properties:
loa_document:
type: string
description: LOA document to upload.
example: '@document.pdf'
responses:
'201':
description: Upload LOA Document response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_loa_upload_response'
4XX:
description: Upload LOA Document response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_loa_upload_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download:
get:
tags:
- Accounts
summary: Cloudflare Download LOA Document
description: Download specified LOA document under the account.
operationId: ip-address-management-prefixes-download-loa-document
parameters:
- name: loa_document_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_loa_document_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Download LOA Document response
content:
application/json:
schema: {}
4XX:
description: Download LOA Document response failure
content:
application/json:
schema:
allOf:
- {}
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes:
get:
tags:
- Accounts
summary: Cloudflare List Prefixes
description: List all prefixes owned by the account.
operationId: ip-address-management-prefixes-list-prefixes
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: List Prefixes response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_response_collection'
4XX:
description: List Prefixes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_response_collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add Prefix
description: Add a new prefix under the account.
operationId: ip-address-management-prefixes-add-prefix
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- cidr
- loa_document_id
- asn
properties:
asn:
$ref: '#/components/schemas/addressing_asn'
cidr:
$ref: '#/components/schemas/addressing_cidr'
loa_document_id:
$ref: '#/components/schemas/addressing_loa_document_identifier'
responses:
'201':
description: Add Prefix response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_single_response'
4XX:
description: Add Prefix response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_single_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Prefix
description: Delete an unapproved prefix owned by the account.
operationId: ip-address-management-prefixes-delete-prefix
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Prefix response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-collection'
4XX:
description: Delete Prefix response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Prefix Details
description: List a particular prefix owned by the account.
operationId: ip-address-management-prefixes-prefix-details
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Prefix Details response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_single_response'
4XX:
description: Prefix Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_single_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update Prefix Description
description: Modify the description for a prefix owned by the account.
operationId: ip-address-management-prefixes-update-prefix-description
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- description
properties:
description:
$ref: '#/components/schemas/addressing_description'
responses:
'200':
description: Update Prefix Description response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_single_response'
4XX:
description: Update Prefix Description response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_single_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes:
get:
tags:
- Accounts
summary: Cloudflare List BGP Prefixes
description: List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.
operationId: ip-address-management-prefixes-list-bgp-prefixes
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: List BGP Prefixes response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_response_collection_bgp'
4XX:
description: List BGP Prefixes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_response_collection_bgp'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}:
get:
tags:
- Accounts
summary: Cloudflare Fetch BGP Prefix
description: Retrieve a single BGP Prefix according to its identifier
operationId: ip-address-management-prefixes-fetch-bgp-prefix
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: bgp_prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Fetch BGP Prefix response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_single_response_bgp'
4XX:
description: Fetch BGP Prefix response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_single_response_bgp'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update BGP Prefix
description: Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).
operationId: ip-address-management-prefixes-update-bgp-prefix
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: bgp_prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_bgp_prefix_update_advertisement'
responses:
'200':
description: Update BGP Prefix response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_single_response_bgp'
4XX:
description: Update BGP Prefix response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_single_response_bgp'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status:
get:
tags:
- Accounts
summary: Cloudflare Get Advertisement Status
description: List the current advertisement state for a prefix.
operationId: ip-address-management-dynamic-advertisement-get-advertisement-status
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Get Advertisement Status response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_advertised_response'
4XX:
description: Get Advertisement Status response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_advertised_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update Prefix Dynamic Advertisement Status
description: Advertise or withdraw BGP route for a prefix.
operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- advertised
properties:
advertised:
$ref: '#/components/schemas/addressing_schemas-advertised'
responses:
'200':
description: Update Prefix Dynamic Advertisement Status response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_advertised_response'
4XX:
description: Update Prefix Dynamic Advertisement Status response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_advertised_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings:
get:
tags:
- Accounts
summary: Cloudflare List Service Bindings
description: 'List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address.
**Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.
'
operationId: ip-address-management-service-bindings-list-service-bindings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Service Bindings attached to the Prefix
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_service_binding'
4XX:
description: List Service Bindings response failure
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Service Binding
description: 'Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare''s network.
**Note:** This API may only be used on prefixes currently configured with a Magic Transit service binding, and only allows creating service bindings for the Cloudflare CDN or Cloudflare Spectrum.
'
operationId: ip-address-management-service-bindings-create-service-binding
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_create_binding_request'
responses:
'201':
description: The created Service Binding
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
$ref: '#/components/schemas/addressing_service_binding'
4XX:
description: Create Service Binding response failure
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Service Binding
description: Delete a Service Binding
operationId: ip-address-management-service-bindings-delete-service-binding
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: binding_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Service Binding deleted
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common'
4XX:
description: Delete Service Binding response failure
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Service Binding
description: Fetch a single Service Binding
operationId: ip-address-management-service-bindings-get-service-binding
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: binding_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: The Service Binding with the requested ID
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
$ref: '#/components/schemas/addressing_service_binding'
4XX:
description: Get Service Binding response failure
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations:
get:
tags:
- Accounts
summary: Cloudflare List Prefix Delegations
description: List all delegations for a given account IP prefix.
operationId: ip-address-management-prefix-delegation-list-prefix-delegations
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: List Prefix Delegations response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_schemas-response_collection'
4XX:
description: List Prefix Delegations response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_schemas-response_collection'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Prefix Delegation
description: Create a new account delegation for a given IP prefix.
operationId: ip-address-management-prefix-delegation-create-prefix-delegation
parameters:
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- cidr
- delegated_account_id
properties:
cidr:
$ref: '#/components/schemas/addressing_cidr'
delegated_account_id:
$ref: '#/components/schemas/addressing_delegated_account_identifier'
responses:
'200':
description: Create Prefix Delegation response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_schemas-single_response'
4XX:
description: Create Prefix Delegation response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_schemas-single_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Prefix Delegation
description: Delete an account delegation for a given IP prefix.
operationId: ip-address-management-prefix-delegation-delete-prefix-delegation
parameters:
- name: delegation_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_delegation_identifier'
- name: prefix_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Prefix Delegation response
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_id_response'
4XX:
description: Delete Prefix Delegation response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_id_response'
- $ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/addressing/services:
get:
tags:
- Accounts
summary: Cloudflare List Services
description: 'Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.
'
operationId: ip-address-management-service-bindings-list-services
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/addressing_identifier'
responses:
'200':
description: Service names and IDs
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
type: array
items:
properties:
id:
$ref: '#/components/schemas/addressing_service_identifier'
name:
$ref: '#/components/schemas/addressing_service_name'
4XX:
description: List Services response failure
content:
application/json:
schema:
$ref: '#/components/schemas/addressing_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/baai/bge-base-en-v1.5 model.
operationId: workers-ai-post-run-cf-baai-bge-base-en-v1-5
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
oneOf:
- type: string
- type: array
maxItems: 100
items:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
data:
type: array
items:
type: array
items:
type: number
shape:
type: array
items:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/baai/bge-large-en-v1.5 model.
operationId: workers-ai-post-run-cf-baai-bge-large-en-v1-5
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
oneOf:
- type: string
- type: array
maxItems: 100
items:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
data:
type: array
items:
type: array
items:
type: number
shape:
type: array
items:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/baai/bge-small-en-v1.5 model.
operationId: workers-ai-post-run-cf-baai-bge-small-en-v1-5
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
oneOf:
- type: string
- type: array
maxItems: 100
items:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
data:
type: array
items:
type: array
items:
type: number
shape:
type: array
items:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/bytedance/stable-diffusion-xl-lightning model.
operationId: workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- prompt
properties:
guidance:
type: number
default: 7.5
image:
type: array
items:
type: number
mask:
type: array
items:
type: number
num_steps:
type: integer
default: 20
maximum: 20
prompt:
type: string
strength:
type: number
default: 1
responses:
'200':
description: Successful response
content:
image/png:
schema:
type: object
properties:
result:
type: string
format: binary
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-base:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-base model.
operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-base
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/deepseek-ai/deepseek-math-7b-instruct model.
operationId: workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/defog/sqlcoder-7b-2 model.
operationId: workers-ai-post-run-cf-defog-sqlcoder-7b-2
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/facebook/bart-large-cnn model.
operationId: workers-ai-post-run-cf-facebook-bart-large-cnn
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- input_text
properties:
input_text:
type: string
max_length:
type: integer
default: 1024
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
summary:
type: string
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/facebook/detr-resnet-50:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/facebook/detr-resnet-50 model.
operationId: workers-ai-post-run-cf-facebook-detr-resnet-50
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
properties:
box:
type: object
properties:
xmax:
type: number
xmin:
type: number
ymax:
type: number
ymin:
type: number
label:
type: string
score:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/huggingface/distilbert-sst-2-int8 model.
operationId: workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
properties:
label:
type: string
score:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/jpmorganchase/roberta-spam:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/jpmorganchase/roberta-spam model.
operationId: workers-ai-post-run-cf-jpmorganchase-roberta-spam
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
properties:
label:
type: string
score:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/lykon/dreamshaper-8-lcm model.
operationId: workers-ai-post-run-cf-lykon-dreamshaper-8-lcm
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- prompt
properties:
guidance:
type: number
default: 7.5
image:
type: array
items:
type: number
mask:
type: array
items:
type: number
num_steps:
type: integer
default: 20
maximum: 20
prompt:
type: string
strength:
type: number
default: 1
responses:
'200':
description: Successful response
content:
image/png:
schema:
type: object
properties:
result:
type: string
format: binary
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/meta/llama-2-7b-chat-fp16 model.
operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-int8:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/meta/llama-2-7b-chat-int8 model.
operationId: workers-ai-post-run-cf-meta-llama-2-7b-chat-int8
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/meta/m2m100-1.2b model.
operationId: workers-ai-post-run-cf-meta-m2m100-1-2b
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
- target_lang
properties:
source_lang:
type: string
default: en
target_lang:
type: string
text:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
translated_text:
type: string
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/microsoft/phi-2:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/microsoft/phi-2 model.
operationId: workers-ai-post-run-cf-microsoft-phi-2
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/microsoft/resnet-50:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/microsoft/resnet-50 model.
operationId: workers-ai-post-run-cf-microsoft-resnet-50
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: object
properties:
label:
type: string
score:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/mistral/mistral-7b-instruct-v0.1 model.
operationId: workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/openai/whisper:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/openai/whisper model.
operationId: workers-ai-post-run-cf-openai-whisper
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
required:
- text
properties:
text:
type: string
word_count:
type: number
words:
type: array
items:
type: object
properties:
end:
type: number
start:
type: number
word:
type: string
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/openchat/openchat-3.5-0106 model.
operationId: workers-ai-post-run-cf-openchat-openchat-3-5-0106
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/qwen/qwen1.5-0.5b-chat model.
operationId: workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/qwen/qwen1.5-1.8b-chat model.
operationId: workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/qwen/qwen1.5-7b-chat-awq model.
operationId: workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/qwen/qwen1.5-14b-chat-awq model.
operationId: workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-img2img model.
operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- prompt
properties:
guidance:
type: number
default: 7.5
image:
type: array
items:
type: number
mask:
type: array
items:
type: number
num_steps:
type: integer
default: 20
maximum: 20
prompt:
type: string
strength:
type: number
default: 1
responses:
'200':
description: Successful response
content:
image/png:
schema:
type: object
properties:
result:
type: string
format: binary
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model.
operationId: workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- prompt
properties:
guidance:
type: number
default: 7.5
image:
type: array
items:
type: number
mask:
type: array
items:
type: number
num_steps:
type: integer
default: 20
maximum: 20
prompt:
type: string
strength:
type: number
default: 1
responses:
'200':
description: Successful response
content:
image/png:
schema:
type: object
properties:
result:
type: string
format: binary
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model.
operationId: workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- prompt
properties:
guidance:
type: number
default: 7.5
image:
type: array
items:
type: number
mask:
type: array
items:
type: number
num_steps:
type: integer
default: 20
maximum: 20
prompt:
type: string
strength:
type: number
default: 1
responses:
'200':
description: Successful response
content:
image/png:
schema:
type: object
properties:
result:
type: string
format: binary
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/thebloke/discolm-german-7b-v1-awq model.
operationId: workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/thebloke/yarn-mistral-7b-64k-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/thebloke/yarn-mistral-7b-64k-awq model.
operationId: workers-ai-post-run-cf-thebloke-yarn-mistral-7b-64k-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/tiiuae/falcon-7b-instruct model.
operationId: workers-ai-post-run-cf-tiiuae-falcon-7b-instruct
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0:
post:
tags:
- Accounts
summary: Cloudflare Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model.
operationId: workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/baai/bge-base-en-v1.5:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/baai/bge-base-en-v1.5 model.
operationId: workers-ai-post-run-hf-baai-bge-base-en-v1-5
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
oneOf:
- type: string
- type: array
maxItems: 100
items:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
data:
type: array
items:
type: array
items:
type: number
shape:
type: array
items:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/sentence-transformers/all-minilm-l6-v2:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/sentence-transformers/all-minilm-l6-v2 model.
operationId: workers-ai-post-run-hf-sentence-transformers-all-minilm-l6-v2
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
type: object
required:
- source
- sentences
properties:
sentences:
type: array
items:
type: string
source:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: number
success:
type: boolean
default: 'true'
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/codellama-7b-instruct-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/codellama-7b-instruct-awq model.
operationId: workers-ai-post-run-hf-thebloke-codellama-7b-instruct-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model.
operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model.
operationId: workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/llama-2-13b-chat-awq model.
operationId: workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/llamaguard-7b-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/llamaguard-7b-awq model.
operationId: workers-ai-post-run-hf-thebloke-llamaguard-7b-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model.
operationId: workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/neural-chat-7b-v3-1-awq model.
operationId: workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/openchat_3.5-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/openchat_3.5-awq model.
operationId: workers-ai-post-run-hf-thebloke-openchat_3-5-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model.
operationId: workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/orca-2-13b-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/orca-2-13b-awq model.
operationId: workers-ai-post-run-hf-thebloke-orca-2-13b-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/starling-lm-7b-alpha-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/starling-lm-7b-alpha-awq model.
operationId: workers-ai-post-run-hf-thebloke-starling-lm-7b-alpha-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq:
post:
tags:
- Accounts
summary: Cloudflare Execute @hf/thebloke/zephyr-7b-beta-awq model.
operationId: workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- prompt
properties:
max_tokens:
type: integer
default: 256
prompt:
type: string
maxLength: 6144
raw:
type: boolean
default: false
stream:
type: boolean
default: false
- required:
- messages
properties:
max_tokens:
type: integer
default: 256
messages:
type: array
items:
type: object
required:
- role
- content
properties:
content:
type: string
maxLength: 6144
role:
type: string
stream:
type: boolean
default: false
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
result:
oneOf:
- type: object
properties:
response:
type: string
- type: string
format: binary
success:
type: boolean
default: 'true'
text/event-stream:
schema: {}
'400':
description: Bad request
content:
application/json:
schema:
type: object
required:
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
result:
type: object
success:
type: boolean
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/ai/run/{model_name}:
post:
tags:
- Accounts
summary: Cloudflare Execute AI model
description: 'This endpoint provides users with the capability to run specific AI models on-demand.
By submitting the required input data, users can receive real-time predictions or results generated by the chosen AI
model. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.
Model specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).'
operationId: workers-ai-post-run-model
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
- name: model_name
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: Model response
content:
application/json:
schema:
type: object
required:
- result
- success
- errors
- messages
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
messages:
type: array
items:
type: string
result:
type: object
success:
type: boolean
example: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
required:
- result
- success
- errors
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
result:
type: object
success:
type: boolean
example: false
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/available_alerts:
get:
tags:
- Accounts
summary: Cloudflare Get Alert Types
description: Gets a list of all alert types for which an account is eligible.
operationId: notification-alert-types-get-alert-types
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: Get Alert Types response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_response_collection'
4XX:
description: Get Alert Types response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/eligible:
get:
tags:
- Accounts
summary: Cloudflare Get delivery mechanism eligibility
description: Get a list of all delivery mechanism types for which an account is eligible.
operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: Get delivery mechanism eligibility response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_schemas-response_collection'
4XX:
description: Get delivery mechanism eligibility response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_schemas-response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/pagerduty:
delete:
tags:
- Accounts
summary: Cloudflare Delete PagerDuty Services
description: Deletes all the PagerDuty Services connected to the account.
operationId: notification-destinations-with-pager-duty-delete-pager-duty-services
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: Delete PagerDuty Services response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_api-response-collection'
4XX:
description: Delete PagerDuty Services response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List PagerDuty services
description: Get a list of all configured PagerDuty services.
operationId: notification-destinations-with-pager-duty-list-pager-duty-services
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: List PagerDuty services response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_components-schemas-response_collection'
4XX:
description: List PagerDuty services response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_components-schemas-response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect:
post:
tags:
- Accounts
summary: Cloudflare Create PagerDuty integration token
description: Creates a new token for integrating with PagerDuty.
operationId: notification-destinations-with-pager-duty-connect-pager-duty
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'201':
description: Token for PagerDuty integration
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_sensitive_id_response'
4XX:
description: Create a token for PagerDuty integration failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}:
get:
tags:
- Accounts
summary: Cloudflare Connect PagerDuty
description: Links PagerDuty with the account using the integration token.
operationId: notification-destinations-with-pager-duty-connect-pager-duty-token
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: token_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_integration-token'
responses:
'200':
description: Create a Notification policy response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_id_response'
4XX:
description: Create a Notification policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/webhooks:
get:
tags:
- Accounts
summary: Cloudflare List webhooks
description: Gets a list of all configured webhook destinations.
operationId: notification-webhooks-list-webhooks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: List webhooks response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
4XX:
description: List webhooks response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a webhook
description: Creates a new webhook destination.
operationId: notification-webhooks-create-a-webhook
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- url
properties:
name:
$ref: '#/components/schemas/aaa_components-schemas-name'
secret:
$ref: '#/components/schemas/aaa_secret'
url:
$ref: '#/components/schemas/aaa_url'
responses:
'201':
description: Create a webhook response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_id_response'
4XX:
description: Create a webhook response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a webhook
description: Delete a configured webhook destination.
operationId: notification-webhooks-delete-a-webhook
parameters:
- name: webhook_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_webhook-id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: Delete a webhook response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_api-response-collection'
4XX:
description: Delete a webhook response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a webhook
description: Get details for a single webhooks destination.
operationId: notification-webhooks-get-a-webhook
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: webhook_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_webhook-id'
responses:
'200':
description: Get a webhook response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_schemas-single_response'
4XX:
description: Get a webhook response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_schemas-single_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a webhook
description: Update a webhook destination.
operationId: notification-webhooks-update-a-webhook
parameters:
- name: webhook_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_webhook-id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- url
properties:
name:
$ref: '#/components/schemas/aaa_components-schemas-name'
secret:
$ref: '#/components/schemas/aaa_secret'
url:
$ref: '#/components/schemas/aaa_url'
responses:
'200':
description: Update a webhook response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_id_response'
4XX:
description: Update a webhook response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/history:
get:
tags:
- Accounts
summary: Cloudflare List History
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: per_page
in: query
schema:
$ref: '#/components/schemas/aaa_per_page'
- name: before
in: query
schema:
$ref: '#/components/schemas/aaa_before'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: since
in: query
schema:
type: string
format: date-time
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'
responses:
'200':
description: List History response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_history_components-schemas-response_collection'
4XX:
description: List History response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_history_components-schemas-response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/policies:
get:
tags:
- Accounts
summary: Cloudflare List Notification policies
description: Get a list of all Notification policies.
operationId: notification-policies-list-notification-policies
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
responses:
'200':
description: List Notification policies response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_policies_components-schemas-response_collection'
4XX:
description: List Notification policies response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Notification policy
description: Creates a new Notification policy.
operationId: notification-policies-create-a-notification-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- alert_type
- enabled
- mechanisms
properties:
alert_type:
$ref: '#/components/schemas/aaa_alert_type'
description:
$ref: '#/components/schemas/aaa_schemas-description'
enabled:
$ref: '#/components/schemas/aaa_enabled'
filters:
$ref: '#/components/schemas/aaa_filters'
mechanisms:
$ref: '#/components/schemas/aaa_mechanisms'
name:
$ref: '#/components/schemas/aaa_schemas-name'
responses:
'200':
description: Create a Notification policy response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_id_response'
4XX:
description: Create a Notification policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/alerting/v3/policies/{policy_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Notification policy
description: Delete a Notification policy.
operationId: notification-policies-delete-a-notification-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_policy-id'
responses:
'200':
description: Delete a Notification policy response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_api-response-collection'
4XX:
description: Delete a Notification policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Notification policy
description: Get details for a single policy.
operationId: notification-policies-get-a-notification-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_policy-id'
responses:
'200':
description: Get a Notification policy response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_single_response'
4XX:
description: Get a Notification policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_single_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Notification policy
description: Update a Notification policy.
operationId: notification-policies-update-a-notification-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_account-id'
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_policy-id'
requestBody:
required: true
content:
application/json:
schema:
properties:
alert_type:
$ref: '#/components/schemas/aaa_alert_type'
description:
$ref: '#/components/schemas/aaa_schemas-description'
enabled:
$ref: '#/components/schemas/aaa_enabled'
filters:
$ref: '#/components/schemas/aaa_filters'
mechanisms:
$ref: '#/components/schemas/aaa_mechanisms'
name:
$ref: '#/components/schemas/aaa_schemas-name'
responses:
'200':
description: Update a Notification policy response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_id_response'
4XX:
description: Update a Notification policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_id_response'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/audit_logs:
get:
tags:
- Accounts
summary: Cloudflare Get account audit logs
description: Gets a list of audit logs for an account. Can be filtered by who made the change, on which zone, and the timeframe of the change.
operationId: audit-logs-get-account-audit-logs
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/aaa_identifier'
- name: id
in: query
schema:
type: string
description: Finds a specific log by its ID.
example: f174be97-19b1-40d6-954d-70cd5fbd52db
- name: export
in: query
schema:
type: boolean
description: Indicates that this request is an export of logs in CSV format.
example: true
- name: action.type
in: query
schema:
type: string
description: Filters by the action type.
example: add
- name: actor.ip
in: query
schema:
type: string
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
- name: actor.email
in: query
schema:
type: string
format: email
description: Filters by the email address of the actor that made the change.
example: alice@example.com
- name: since
in: query
schema:
type: string
format: date-time
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'
- name: before
in: query
schema:
type: string
format: date-time
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'
- name: zone.name
in: query
schema:
type: string
description: Filters by the name of the zone associated to the change.
example: example.com
- name: direction
in: query
schema:
type: string
description: Changes the direction of the chronological sorting.
enum:
- desc
- asc
default: desc
example: desc
- name: per_page
in: query
schema:
type: number
description: Sets the number of results to return per page.
default: 100
example: 25
minimum: 1
maximum: 1000
- name: page
in: query
schema:
type: number
description: Defines which page of results to return.
default: 1
example: 50
minimum: 1
- name: hide_user_logs
in: query
schema:
type: boolean
description: Indicates whether or not to hide user level audit logs.
default: false
responses:
'200':
description: Get account audit logs response
content:
application/json:
schema:
$ref: '#/components/schemas/aaa_audit_logs_response_collection'
4XX:
description: Get account audit logs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/aaa_audit_logs_response_collection'
- $ref: '#/components/schemas/aaa_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/brand-protection/submit:
post:
tags:
- Accounts
summary: Cloudflare Submit suspicious URL for scanning
operationId: phishing-url-scanner-submit-suspicious-url-for-scanning
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_url_param'
type: object
responses:
'200':
description: Submit suspicious URL for scanning response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
4XX:
description: Submit suspicious URL for scanning response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_phishing-url-submit_components-schemas-single_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/brand-protection/url-info:
get:
tags:
- Accounts
summary: Cloudflare Get results for a URL scan
operationId: phishing-url-information-get-results-for-a-url-scan
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: url_id_param
in: query
schema:
$ref: '#/components/schemas/intel_url_id_param'
- name: url
in: query
schema:
type: string
responses:
'200':
description: Get results for a URL scan response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
4XX:
description: Get results for a URL scan response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_phishing-url-info_components-schemas-single_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/calls/apps:
get:
tags:
- Accounts
summary: Cloudflare List apps
description: Lists all apps in the Cloudflare account
operationId: calls-apps-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_account_identifier'
responses:
'200':
description: List apps response
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_response_collection'
4XX:
description: List videos response failure
content:
application/json:
schema:
$ref: '#/components/schemas/calls_api-response-common-failure'
security:
- api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create a new app
description: Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.
operationId: calls-apps-create-a-new-app
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_editable_fields'
responses:
'201':
description: Created a new app
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_response_single_with_secret'
security:
- api_token: []
/accounts/{account_id}/calls/apps/{app_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete app
description: Deletes an app from Cloudflare Calls
operationId: calls-apps-delete-app
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_account_identifier'
responses:
'200':
description: Delete app response
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_response_single'
4XX:
description: Delete app response failure
content:
application/json: {}
security:
- api_token: []
get:
tags:
- Accounts
summary: Cloudflare Retrieve app details
description: Fetches details for a single Calls app.
operationId: calls-apps-retrieve-app-details
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_account_identifier'
responses:
'200':
description: Retrieve app details response
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_response_single'
4XX:
description: Retrieve video details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/calls_api-response-common-failure'
security:
- api_token: []
put:
tags:
- Accounts
summary: Cloudflare Edit app details
description: Edit details for a single app.
operationId: calls-apps-update-app-details
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/calls_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_editable_fields'
responses:
'200':
description: Edit app details response
content:
application/json:
schema:
$ref: '#/components/schemas/calls_app_response_single'
4XX:
description: Edit app details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/calls_api-response-common-failure'
security:
- api_token: []
/accounts/{account_id}/cfd_tunnel:
get:
tags:
- Accounts
summary: List Cloudflare Tunnels
description: Lists and filters Cloudflare Tunnels in an account.
operationId: cloudflare-tunnel-list-cloudflare-tunnels
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: name
in: query
schema:
type: string
description: A user-friendly name for the tunnel.
example: blog
- name: is_deleted
in: query
schema:
type: boolean
description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
example: true
- name: existed_at
in: query
schema:
$ref: '#/components/schemas/tunnel_existed_at'
- name: uuid
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: was_active_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: was_inactive_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: include_prefix
in: query
schema:
type: string
example: vpc1-
- name: exclude_prefix
in: query
schema:
type: string
example: vpc1-
- name: per_page
in: query
schema:
$ref: '#/components/schemas/tunnel_per_page'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
responses:
'200':
description: List Cloudflare Tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-collection'
4XX:
description: List Cloudflare Tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-collection'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Create a Cloudflare Tunnel
description: Creates a new Cloudflare Tunnel in an account.
operationId: cloudflare-tunnel-create-a-cloudflare-tunnel
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
config_src:
$ref: '#/components/schemas/tunnel_config_src'
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
tunnel_secret:
$ref: '#/components/schemas/tunnel_tunnel_secret'
responses:
'200':
description: Create a Cloudflare Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Create a Cloudflare Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}:
delete:
tags:
- Accounts
summary: Delete a Cloudflare Tunnel
description: Deletes a Cloudflare Tunnel from an account.
operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Delete a Cloudflare Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Delete a Cloudflare Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Get a Cloudflare Tunnel
description: Fetches a single Cloudflare Tunnel.
operationId: cloudflare-tunnel-get-a-cloudflare-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get a Cloudflare Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Get a Cloudflare Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Update a Cloudflare Tunnel
description: Updates an existing Cloudflare Tunnel.
operationId: cloudflare-tunnel-update-a-cloudflare-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
tunnel_secret:
$ref: '#/components/schemas/tunnel_tunnel_secret'
responses:
'200':
description: Update a Cloudflare Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Update a Cloudflare Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations:
get:
tags:
- Accounts
summary: Cloudflare Get configuration
description: Gets the configuration for a remotely-managed tunnel
operationId: cloudflare-tunnel-configuration-get-configuration
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_identifier'
responses:
'200':
description: Get configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_config_response_single'
4XX:
description: Get configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_config_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Put configuration
description: Adds or updates the configuration for a remotely-managed tunnel.
operationId: cloudflare-tunnel-configuration-put-configuration
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
config:
$ref: '#/components/schemas/tunnel_config'
responses:
'200':
description: Put configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_config_response_single'
4XX:
description: Put configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_config_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections:
delete:
tags:
- Accounts
summary: Clean up Cloudflare Tunnel connections
description: Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.
operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: client_id
in: query
schema:
type: string
description: UUID of the Cloudflare Tunnel Connector to disconnect.
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Clean up Cloudflare Tunnel connections response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_empty_response'
4XX:
description: Clean up Cloudflare Tunnel connections response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_empty_response'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: List Cloudflare Tunnel connections
description: Fetches connection details for a Cloudflare Tunnel.
operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
responses:
'200':
description: List Cloudflare Tunnel connections response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel_connections_response'
4XX:
description: List Cloudflare Tunnel connections response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel_connections_response'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}:
get:
tags:
- Accounts
summary: Get Cloudflare Tunnel connector
description: Fetches connector and connection details for a Cloudflare Tunnel.
operationId: cloudflare-tunnel-get-cloudflare-tunnel-connector
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: connector_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_client_id'
responses:
'200':
description: Get Cloudflare Tunnel connector response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel_client_response'
4XX:
description: Get Cloudflare Tunnel connector response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel_client_response'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/management:
post:
tags:
- Accounts
summary: Get a Cloudflare Tunnel management token
description: Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.
operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-management-token
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- resources
properties:
resources:
type: array
items:
$ref: '#/components/schemas/tunnel_management-resources'
responses:
'200':
description: Get a Cloudflare Tunnel management token response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel_response_token'
4XX:
description: Cloudflare API response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel_response_token'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/token:
get:
tags:
- Accounts
summary: Get a Cloudflare Tunnel token
description: Gets the token used to associate cloudflared with a specific tunnel.
operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get a Cloudflare Tunnel token response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel_response_token'
4XX:
description: Get a Cloudflare Tunnel token response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel_response_token'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/challenges/widgets:
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/turnstile_identifier'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Number of items per page.
default: 25
minimum: 5
maximum: 1000
- name: order
in: query
schema:
description: Field to order widgets by.
enum:
- id
- sitekey
- name
- created_on
- modified_on
example: id
- name: direction
in: query
schema:
description: Direction to order widgets.
enum:
- asc
- desc
example: asc
get:
tags:
- Accounts
summary: Cloudflare List Turnstile Widgets
description: Lists all turnstile widgets of an account.
operationId: accounts-turnstile-widgets-list
responses:
'200':
description: List Turnstile Widgets
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result_info:
$ref: '#/components/schemas/turnstile_result_info'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/turnstile_widget_list'
4XX:
description: List Turnstile Widgets Error
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Turnstile Widget
description: Lists challenge widgets.
operationId: accounts-turnstile-widget-create
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- mode
- domains
properties:
bot_fight_mode:
$ref: '#/components/schemas/turnstile_bot_fight_mode'
clearance_level:
$ref: '#/components/schemas/turnstile_clearance_level'
domains:
$ref: '#/components/schemas/turnstile_domains'
mode:
$ref: '#/components/schemas/turnstile_mode'
name:
$ref: '#/components/schemas/turnstile_name'
offlabel:
$ref: '#/components/schemas/turnstile_offlabel'
region:
$ref: '#/components/schemas/turnstile_region'
responses:
'200':
description: Create Turnstile Widget Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result_info:
$ref: '#/components/schemas/turnstile_result_info'
- properties:
result:
$ref: '#/components/schemas/turnstile_widget_detail'
4XX:
description: Create Turnstile Widget Response Error
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/challenges/widgets/{sitekey}:
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/turnstile_identifier'
- name: sitekey
in: path
required: true
schema:
$ref: '#/components/schemas/turnstile_sitekey'
delete:
tags:
- Accounts
summary: Cloudflare Delete a Turnstile Widget
description: Destroy a Turnstile Widget.
operationId: accounts-turnstile-widget-delete
responses:
'200':
description: Delete Turnstile Widget Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result:
$ref: '#/components/schemas/turnstile_widget_detail'
4XX:
description: Delete Turnstile Widget Response
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Turnstile Widget Details
description: Show a single challenge widget configuration.
operationId: accounts-turnstile-widget-get
responses:
'200':
description: Turnstile Widget Details Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result:
$ref: '#/components/schemas/turnstile_widget_detail'
4XX:
description: Turnstile Widget Details Response Error
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Turnstile Widget
description: Update the configuration of a widget.
operationId: accounts-turnstile-widget-update
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- mode
- domains
properties:
bot_fight_mode:
$ref: '#/components/schemas/turnstile_bot_fight_mode'
clearance_level:
$ref: '#/components/schemas/turnstile_clearance_level'
domains:
$ref: '#/components/schemas/turnstile_domains'
mode:
$ref: '#/components/schemas/turnstile_mode'
name:
$ref: '#/components/schemas/turnstile_name'
offlabel:
$ref: '#/components/schemas/turnstile_offlabel'
responses:
'200':
description: Update Turnstile Widget Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result:
$ref: '#/components/schemas/turnstile_widget_detail'
4XX:
description: Update Turnstile Widget Response Error
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret:
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/turnstile_identifier'
- name: sitekey
in: path
required: true
schema:
$ref: '#/components/schemas/turnstile_sitekey'
post:
tags:
- Accounts
summary: Cloudflare Rotate Secret for a Turnstile Widget
description: 'Generate a new secret key for this widget. If `invalidate_immediately`
is set to `false`, the previous secret remains valid for 2 hours.
Note that secrets cannot be rotated again during the grace period.
'
operationId: accounts-turnstile-widget-rotate-secret
requestBody:
required: true
content:
application/json:
schema:
properties:
invalidate_immediately:
$ref: '#/components/schemas/turnstile_invalidate_immediately'
responses:
'200':
description: Rotate Secret Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/turnstile_api-response-common'
- properties:
result:
$ref: '#/components/schemas/turnstile_widget_detail'
4XX:
description: Rotate Secret Response Error
content:
application/json:
schema:
$ref: '#/components/schemas/turnstile_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/custom_ns:
get:
tags:
- Accounts
summary: Cloudflare List Account Custom Nameservers
description: List an account's custom nameservers.
operationId: account-level-custom-nameservers-list-account-custom-nameservers
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_identifier'
responses:
'200':
description: List Account Custom Nameservers response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
4XX:
description: List Account Custom Nameservers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add Account Custom Nameserver
operationId: account-level-custom-nameservers-add-account-custom-nameserver
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_CustomNSInput'
responses:
'200':
description: Add Account Custom Nameserver response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_acns_response_single'
4XX:
description: Add Account Custom Nameserver response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_acns_response_single'
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/custom_ns/{custom_ns_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Account Custom Nameserver
operationId: account-level-custom-nameservers-delete-account-custom-nameserver
parameters:
- name: custom_ns_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_ns_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Account Custom Nameserver response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_empty_response'
4XX:
description: Delete Account Custom Nameserver response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_empty_response'
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/custom_ns/availability:
get:
tags:
- Accounts
summary: Cloudflare Get Eligible Zones for Account Custom Nameservers
operationId: account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_identifier'
responses:
'200':
description: Get Eligible Zones for Account Custom Nameservers response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_availability_response'
4XX:
description: Get Eligible Zones for Account Custom Nameservers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_availability_response'
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/custom_ns/verify:
post:
tags:
- Accounts
summary: Cloudflare Verify Account Custom Nameserver Glue Records
operationId: account-level-custom-nameservers-verify-account-custom-nameserver-glue-records
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-custom-nameservers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Verify Account Custom Nameserver Glue Records response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
4XX:
description: Verify Account Custom Nameserver Glue Records response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_acns_response_collection'
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{account_id}/d1/database:
get:
tags:
- Accounts
summary: Cloudflare List D1 Databases
description: Returns a list of D1 databases.
operationId: cloudflare-d1-list-databases
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/d1_account-identifier'
- name: name
in: query
schema:
type: string
description: a database name to search for.
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Number of items per page.
default: 1000
minimum: 10
maximum: 10000
responses:
'200':
description: List D1 databases response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/d1_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/d1_create-database-response'
result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
4XX:
description: List D1 databases response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/d1_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create D1 Database
description: Returns the created D1 database.
operationId: cloudflare-d1-create-database
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/d1_account-identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
$ref: '#/components/schemas/d1_database-name'
responses:
'200':
description: Returns the created D1 database's metadata
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- properties:
result:
$ref: '#/components/schemas/d1_create-database-response'
4XX:
description: Database details response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/d1_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/devices:
get:
tags:
- Accounts
summary: Cloudflare List devices
description: Fetches a list of enrolled devices.
operationId: devices-list-devices
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: List devices response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_devices_response'
4XX:
description: List devices response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_devices_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/{device_id}:
get:
tags:
- Accounts
summary: Cloudflare Get device details
description: Fetches details for a single device.
operationId: devices-device-details
parameters:
- name: device_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_response'
4XX:
description: Get device details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/{device_id}/override_codes:
get:
tags:
- Accounts
summary: Cloudflare Get an admin override code for a device
description: Fetches a 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:
- name: device_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get an admin override code for a device response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_override_codes_response'
4XX:
description: Get an admin override code for a device response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_override_codes_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/dex_tests:
get:
tags:
- Accounts
summary: Cloudflare List Device DEX tests
description: Fetch all DEX tests.
operationId: device-dex-test-details
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Device DEX test details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_dex-response_collection'
4XX:
description: Device DEX test response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_dex-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Device DEX test
description: Create a DEX test.
operationId: device-dex-test-create-device-dex-test
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
responses:
'200':
description: Update Dex test response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_dex-single_response'
4XX:
description: Update Dex test response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_dex-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/dex_tests/{dex_test_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Device DEX test
description: Delete a Device DEX test. Returns the remaining device dex tests for the account.
operationId: device-dex-test-delete-device-dex-test
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
- name: dex_test_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
responses:
'200':
description: Delete Device DEX test response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_dex-response_collection'
4XX:
description: Delete DEX test response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_dex-response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Device DEX test
description: Fetch a single DEX test.
operationId: device-dex-test-get-device-dex-test
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
- name: dex_test_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
responses:
'200':
description: Device DEX test details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_dex-single_response'
4XX:
description: Device DEX test response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_dex-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Device DEX test
description: Update a DEX test.
operationId: device-dex-test-update-device-dex-test
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
- name: dex_test_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
responses:
'200':
description: Update Dex test response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_dex-single_response'
4XX:
description: Update Dex test response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_dex-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/networks:
get:
tags:
- Accounts
summary: Cloudflare List your device managed networks
description: Fetches a list of managed networks for an account.
operationId: device-managed-networks-list-device-managed-networks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: List your device managed networks response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
4XX:
description: List your device managed networks response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a device managed network
description: Creates a new device managed network.
operationId: device-managed-networks-create-device-managed-network
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- type
- config
properties:
config:
$ref: '#/components/schemas/teams-devices_schemas-config_request'
name:
$ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
type:
$ref: '#/components/schemas/teams-devices_components-schemas-type'
responses:
'200':
description: Create a device managed networks response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_components-schemas-single_response'
4XX:
description: Create a device managed networks response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/networks/{network_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a device managed network
description: Deletes a device managed network and fetches a list of the remaining device managed networks for an account.
operationId: device-managed-networks-delete-device-managed-network
parameters:
- name: network_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a device managed network response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
4XX:
description: Delete a device managed network response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_components-schemas-response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get device managed network details
description: Fetches details for a single managed network.
operationId: device-managed-networks-device-managed-network-details
parameters:
- name: network_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device managed network details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_components-schemas-single_response'
4XX:
description: Get device managed network details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a device managed network
description: Updates a configured device managed network.
operationId: device-managed-networks-update-device-managed-network
parameters:
- name: network_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
config:
$ref: '#/components/schemas/teams-devices_schemas-config_request'
name:
$ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
type:
$ref: '#/components/schemas/teams-devices_components-schemas-type'
responses:
'200':
description: Update a device managed network response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_components-schemas-single_response'
4XX:
description: Update a device managed network response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_components-schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policies:
get:
tags:
- Accounts
summary: Cloudflare List device settings profiles
description: Fetches a list of the device settings profiles for an account.
operationId: devices-list-device-settings-policies
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: List device settings profiles response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_settings_response_collection'
4XX:
description: List device settings profiles response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy:
get:
tags:
- Accounts
summary: Cloudflare Get the default device settings profile
description: Fetches the default device settings profile for an account.
operationId: devices-get-default-device-settings-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the default device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_default_device_settings_response'
4XX:
description: Get the default device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_default_device_settings_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update the default device settings profile
description: Updates the default device settings profile for an account.
operationId: devices-update-default-device-settings-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
allow_mode_switch:
$ref: '#/components/schemas/teams-devices_allow_mode_switch'
allow_updates:
$ref: '#/components/schemas/teams-devices_allow_updates'
allowed_to_leave:
$ref: '#/components/schemas/teams-devices_allowed_to_leave'
auto_connect:
$ref: '#/components/schemas/teams-devices_auto_connect'
captive_portal:
$ref: '#/components/schemas/teams-devices_captive_portal'
disable_auto_fallback:
$ref: '#/components/schemas/teams-devices_disable_auto_fallback'
exclude_office_ips:
$ref: '#/components/schemas/teams-devices_exclude_office_ips'
service_mode_v2:
$ref: '#/components/schemas/teams-devices_service_mode_v2'
support_url:
$ref: '#/components/schemas/teams-devices_support_url'
switch_locked:
$ref: '#/components/schemas/teams-devices_switch_locked'
responses:
'200':
description: Update the default device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_default_device_settings_response'
4XX:
description: Update the default device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_default_device_settings_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a device settings profile
description: Creates a device settings profile to be applied to certain devices matching the criteria.
operationId: devices-create-device-settings-policy
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- precedence
- match
properties:
allow_mode_switch:
$ref: '#/components/schemas/teams-devices_allow_mode_switch'
allow_updates:
$ref: '#/components/schemas/teams-devices_allow_updates'
allowed_to_leave:
$ref: '#/components/schemas/teams-devices_allowed_to_leave'
auto_connect:
$ref: '#/components/schemas/teams-devices_auto_connect'
captive_portal:
$ref: '#/components/schemas/teams-devices_captive_portal'
description:
$ref: '#/components/schemas/teams-devices_schemas-description'
disable_auto_fallback:
$ref: '#/components/schemas/teams-devices_disable_auto_fallback'
enabled:
type: boolean
description: Whether the policy will be applied to matching devices.
example: true
exclude_office_ips:
$ref: '#/components/schemas/teams-devices_exclude_office_ips'
lan_allow_minutes:
$ref: '#/components/schemas/teams-devices_lan_allow_minutes'
lan_allow_subnet_size:
$ref: '#/components/schemas/teams-devices_lan_allow_subnet_size'
match:
$ref: '#/components/schemas/teams-devices_schemas-match'
name:
type: string
description: The name of the device settings profile.
example: Allow Developers
maxLength: 100
precedence:
$ref: '#/components/schemas/teams-devices_precedence'
service_mode_v2:
$ref: '#/components/schemas/teams-devices_service_mode_v2'
support_url:
$ref: '#/components/schemas/teams-devices_support_url'
switch_locked:
$ref: '#/components/schemas/teams-devices_switch_locked'
responses:
'200':
description: Create a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_settings_response'
4XX:
description: Create a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_settings_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/{policy_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a device settings profile
description: Deletes a device settings profile and fetches a list of the remaining profiles for an account.
operationId: devices-delete-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_settings_response_collection'
4XX:
description: Delete a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_settings_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get device settings profile by ID
description: Fetches a device settings profile by ID.
operationId: devices-get-device-settings-policy-by-id
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device settings profile by ID response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_settings_response'
4XX:
description: Get device settings profile by ID response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_settings_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a device settings profile
description: Updates a configured device settings profile.
operationId: devices-update-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
allow_mode_switch:
$ref: '#/components/schemas/teams-devices_allow_mode_switch'
allow_updates:
$ref: '#/components/schemas/teams-devices_allow_updates'
allowed_to_leave:
$ref: '#/components/schemas/teams-devices_allowed_to_leave'
auto_connect:
$ref: '#/components/schemas/teams-devices_auto_connect'
captive_portal:
$ref: '#/components/schemas/teams-devices_captive_portal'
description:
$ref: '#/components/schemas/teams-devices_schemas-description'
disable_auto_fallback:
$ref: '#/components/schemas/teams-devices_disable_auto_fallback'
enabled:
type: boolean
description: Whether the policy will be applied to matching devices.
example: true
exclude_office_ips:
$ref: '#/components/schemas/teams-devices_exclude_office_ips'
match:
$ref: '#/components/schemas/teams-devices_schemas-match'
name:
type: string
description: The name of the device settings profile.
example: Allow Developers
maxLength: 100
precedence:
$ref: '#/components/schemas/teams-devices_precedence'
service_mode_v2:
$ref: '#/components/schemas/teams-devices_service_mode_v2'
support_url:
$ref: '#/components/schemas/teams-devices_support_url'
switch_locked:
$ref: '#/components/schemas/teams-devices_switch_locked'
responses:
'200':
description: Update a device settings profile Policy response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_device_settings_response'
4XX:
description: Update a device settings profile Policy response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_device_settings_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/{policy_id}/exclude:
get:
tags:
- Accounts
summary: Cloudflare Get the Split Tunnel exclude list for a device settings profile
description: Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the Split Tunnel exclude list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
4XX:
description: Get the Split Tunnel exclude list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set the Split Tunnel exclude list for a device settings profile
description: Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel'
responses:
'200':
description: Set the Split Tunnel exclude list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
4XX:
description: Set the Split Tunnel exclude list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains:
get:
tags:
- Accounts
summary: Cloudflare Get the Local Domain Fallback list for a device settings profile
description: Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.
operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the Local Domain Fallback list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
4XX:
description: Get the Local Domain Fallback list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set the Local Domain Fallback list for a device settings profile
description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.
operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_fallback_domain'
responses:
'200':
description: Set the Local Domain Fallback list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
4XX:
description: Set the Local Domain Fallback list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/{policy_id}/include:
get:
tags:
- Accounts
summary: Cloudflare Get the Split Tunnel include list for a device settings profile
description: Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.
operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the Split Tunnel include list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
4XX:
description: Get the Split Tunnel include list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set the Split Tunnel include list for a device settings profile
description: Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.
operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy
parameters:
- name: policy_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel_include'
responses:
'200':
description: Set the Split Tunnel include list for a device settings profile response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
4XX:
description: Set the Split Tunnel include list for a device settings profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/exclude:
get:
tags:
- Accounts
summary: Cloudflare Get the Split Tunnel exclude list
description: Fetches the list of routes excluded from the WARP client's tunnel.
operationId: devices-get-split-tunnel-exclude-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the Split Tunnel exclude list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
4XX:
description: Get the Split Tunnel exclude list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set the Split Tunnel exclude list
description: Sets the list of routes excluded from the WARP client's tunnel.
operationId: devices-set-split-tunnel-exclude-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel'
responses:
'200':
description: Set the Split Tunnel exclude list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
4XX:
description: Set the Split Tunnel exclude list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/fallback_domains:
get:
tags:
- Accounts
summary: Cloudflare Get your Local Domain Fallback list
description: Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
operationId: devices-get-local-domain-fallback-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get your Local Domain Fallback list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
4XX:
description: Get your Local Domain Fallback list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set your Local Domain Fallback list
description: Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.
operationId: devices-set-local-domain-fallback-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_fallback_domain'
responses:
'200':
description: Set your Local Domain Fallback list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
4XX:
description: Set your Local Domain Fallback list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_fallback_domain_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/policy/include:
get:
tags:
- Accounts
summary: Cloudflare Get the Split Tunnel include list
description: Fetches the list of routes included in the WARP client's tunnel.
operationId: devices-get-split-tunnel-include-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get the Split Tunnel include list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
4XX:
description: Get the Split Tunnel include list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Set the Split Tunnel include list
description: Sets the list of routes included in the WARP client's tunnel.
operationId: devices-set-split-tunnel-include-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel_include'
responses:
'200':
description: Set the Split Tunnel include list response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
4XX:
description: Set the Split Tunnel include list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_split_tunnel_include_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/posture:
get:
tags:
- Accounts
summary: Cloudflare List device posture rules
description: Fetches device posture rules for a Zero Trust account.
operationId: device-posture-rules-list-device-posture-rules
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: List device posture rules response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_response_collection'
4XX:
description: List device posture rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a device posture rule
description: Creates a new device posture rule.
operationId: device-posture-rules-create-device-posture-rule
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- type
properties:
description:
$ref: '#/components/schemas/teams-devices_description'
expiration:
$ref: '#/components/schemas/teams-devices_expiration'
input:
$ref: '#/components/schemas/teams-devices_input'
match:
$ref: '#/components/schemas/teams-devices_match'
name:
$ref: '#/components/schemas/teams-devices_name'
schedule:
$ref: '#/components/schemas/teams-devices_schedule'
type:
$ref: '#/components/schemas/teams-devices_type'
responses:
'200':
description: Create device posture rule response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_single_response'
4XX:
description: Create device posture rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/posture/{rule_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a device posture rule
description: Deletes a device posture rule.
operationId: device-posture-rules-delete-device-posture-rule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a device posture rule response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_id_response'
4XX:
description: Delete a device posture rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_id_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get device posture rule details
description: Fetches a single device posture rule.
operationId: device-posture-rules-device-posture-rules-details
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device posture rule details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_single_response'
4XX:
description: Get device posture rule details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a device posture rule
description: Updates a device posture rule.
operationId: device-posture-rules-update-device-posture-rule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- type
properties:
description:
$ref: '#/components/schemas/teams-devices_description'
expiration:
$ref: '#/components/schemas/teams-devices_expiration'
input:
$ref: '#/components/schemas/teams-devices_input'
match:
$ref: '#/components/schemas/teams-devices_match'
name:
$ref: '#/components/schemas/teams-devices_name'
schedule:
$ref: '#/components/schemas/teams-devices_schedule'
type:
$ref: '#/components/schemas/teams-devices_type'
responses:
'200':
description: Update a device posture rule response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_single_response'
4XX:
description: Update a device posture rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/posture/integration:
get:
tags:
- Accounts
summary: Cloudflare List your device posture integrations
description: Fetches the list of device posture integrations for an account.
operationId: device-posture-integrations-list-device-posture-integrations
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: List your device posture integrations response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_schemas-response_collection'
4XX:
description: List your device posture integrations response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_schemas-response_collection'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a device posture integration
description: Create a new device posture integration.
operationId: device-posture-integrations-create-device-posture-integration
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- type
- interval
- config
properties:
config:
$ref: '#/components/schemas/teams-devices_config_request'
interval:
$ref: '#/components/schemas/teams-devices_interval'
name:
$ref: '#/components/schemas/teams-devices_components-schemas-name'
type:
$ref: '#/components/schemas/teams-devices_schemas-type'
responses:
'200':
description: Create a device posture integration response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_schemas-single_response'
4XX:
description: Create a device posture integration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/posture/integration/{integration_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a device posture integration
description: Delete a configured device posture integration.
operationId: device-posture-integrations-delete-device-posture-integration
parameters:
- name: integration_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a device posture integration response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_schemas-id_response'
4XX:
description: Delete a device posture integration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_schemas-id_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get device posture integration details
description: Fetches details for a single device posture integration.
operationId: device-posture-integrations-device-posture-integration-details
parameters:
- name: integration_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device posture integration details response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_schemas-single_response'
4XX:
description: Get device posture integration details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a device posture integration
description: Updates a configured device posture integration.
operationId: device-posture-integrations-update-device-posture-integration
parameters:
- name: integration_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
config:
$ref: '#/components/schemas/teams-devices_config_request'
interval:
$ref: '#/components/schemas/teams-devices_interval'
name:
$ref: '#/components/schemas/teams-devices_components-schemas-name'
type:
$ref: '#/components/schemas/teams-devices_schemas-type'
responses:
'200':
description: Update a device posture integration response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_schemas-single_response'
4XX:
description: Update a device posture integration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_schemas-single_response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/revoke:
post:
tags:
- Accounts
summary: Cloudflare Revoke devices
description: Revokes a list of devices.
operationId: devices-revoke-devices
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_revoke_devices_request'
responses:
'200':
description: Revoke devices response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_api-response-single'
4XX:
description: Revoke devices response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/settings:
get:
tags:
- Accounts
summary: Cloudflare Get device settings for a Zero Trust account
description: Describes the current device settings for a Zero Trust account.
operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
responses:
'200':
description: Get device settings for a Zero Trust account response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
4XX:
description: Get device settings for a Zero Trust account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update device settings for a Zero Trust account
description: Updates the current device settings for a Zero Trust account.
operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
responses:
'200':
description: Update device settings for a Zero Trust account response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
4XX:
description: Update device settings for a Zero Trust account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/devices/unrevoke:
post:
tags:
- Accounts
summary: Cloudflare Unrevoke devices
description: Unrevokes a list of devices.
operationId: devices-unrevoke-devices
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/teams-devices_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_unrevoke_devices_request'
responses:
'200':
description: Unrevoke devices response
content:
application/json:
schema:
$ref: '#/components/schemas/teams-devices_api-response-single'
4XX:
description: Unrevoke devices response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- $ref: '#/components/schemas/teams-devices_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/dex/colos:
get:
tags:
- Accounts
summary: List Cloudflare colos
description: List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.
operationId: dex-endpoints-list-colos
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: timeStart
in: query
description: Start time for connection period in RFC3339 (ISO 8601) format.
required: true
schema:
type: string
example: '2023-08-20T20:45:00Z'
- name: timeEnd
in: query
description: End time for connection period in RFC3339 (ISO 8601) format.
required: true
schema:
type: string
example: '2023-08-24T20:45:00Z'
- name: sortBy
in: query
description: Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically.
schema:
type: string
enum:
- fleet-status-usage
- application-tests-usage
responses:
'200':
description: List colos response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_colos_response'
4XX:
description: List colos failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/fleet-status/devices:
get:
tags:
- Accounts
summary: Cloudflare List fleet status devices
description: List details for devices using WARP
operationId: dex-fleet-status-devices
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: time_end
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_timestamp'
- name: time_start
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_timestamp'
- name: page
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_page'
- name: per_page
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_per_page'
- name: sort_by
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_sort_by'
- name: colo
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_colo'
- name: device_id
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_device_id'
- name: mode
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_mode'
- name: status
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_status'
- name: platform
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_platform'
- name: version
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_version'
responses:
'200':
description: List devices response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_fleet_status_devices_response'
4xx:
description: List devices response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/fleet-status/live:
get:
tags:
- Accounts
summary: Cloudflare List fleet status details by dimension
description: List details for live (up to 60 minutes) devices using WARP
operationId: dex-fleet-status-live
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: since_minutes
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_since_minutes'
responses:
'200':
description: List device details (live) response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_fleet_status_live_response'
4xx:
description: List device details (live) response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/fleet-status/over-time:
get:
tags:
- Accounts
summary: Cloudflare List fleet status aggregate details by dimension
description: List details for devices using WARP, up to 7 days
operationId: dex-fleet-status-over-time
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: time_end
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_timestamp'
- name: time_start
in: query
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_timestamp'
- name: colo
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_colo'
- name: device_id
in: query
schema:
$ref: '#/components/schemas/digital-experience-monitoring_device_id'
responses:
'200':
description: List DEX devices response
4xx:
description: DEX HTTP test details failure response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/http-tests/{test_id}:
get:
tags:
- Accounts
summary: Cloudflare Get details and aggregate metrics for an http test
description: Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.
operationId: dex-endpoints-http-test-details
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_id
in: path
description: unique identifier for a specific test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
- name: timeStart
in: query
description: Start time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689520412000
- name: timeEnd
in: query
description: End time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689606812000
- name: interval
in: query
description: Time interval for aggregate time slots.
required: true
schema:
type: string
enum:
- minute
- hour
- name: colo
in: query
description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
schema:
type: string
responses:
'200':
description: DEX HTTP test details response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_http_details_response'
4XX:
description: DEX HTTP test details failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/http-tests/{test_id}/percentiles:
get:
tags:
- Accounts
summary: Cloudflare Get percentiles for an http test
description: Get percentiles for an http test for a given time period between 1 hour and 7 days.
operationId: dex-endpoints-http-test-percentiles
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_id
in: path
description: unique identifier for a specific test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
- name: timeStart
in: query
description: Start time for aggregate metrics in ISO format
required: true
schema:
type: string
example: '2023-09-20T17:00:00Z'
- name: timeEnd
in: query
description: End time for aggregate metrics in ISO format
required: true
schema:
type: string
example: '2023-09-20T17:00:00Z'
- name: colo
in: query
description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
schema:
type: string
responses:
'200':
description: DEX HTTP test percentiles response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_http_details_percentiles_response'
4XX:
description: DEX HTTP test percentiles failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/tests:
get:
tags:
- Accounts
summary: Cloudflare List DEX test analytics
description: List DEX tests
operationId: dex-endpoints-list-tests
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: colo
in: query
description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
schema:
type: string
- name: testName
in: query
description: Optionally filter results by test name
schema:
type: string
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
- name: page
in: query
description: Page number of paginated results
schema:
type: number
default: 1
minimum: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: number
default: 10
minimum: 1
maximum: 50
responses:
'200':
description: DEX tests list response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_tests_response'
result_info:
$ref: '#/components/schemas/digital-experience-monitoring_result_info'
4XX:
description: List DEX tests failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/tests/unique-devices:
get:
tags:
- Accounts
summary: Cloudflare Get count of devices targeted
description: Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.
operationId: dex-endpoints-tests-unique-devices
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: testName
in: query
description: Optionally filter results by test name
schema:
type: string
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
responses:
'200':
description: DEX unique devices targeted response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_unique_devices_response'
4XX:
description: DEX unique devices targeted failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path:
get:
tags:
- Accounts
summary: Cloudflare Get details for a specific traceroute test run
description: Get a breakdown of hops and performance metrics for a specific traceroute test run
operationId: dex-endpoints-traceroute-test-result-network-path
parameters:
- name: account_id
in: path
description: unique identifier linked to an account
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_result_id
in: path
description: unique identifier for a specific traceroute test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
responses:
'200':
description: DEX traceroute test result network path response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_traceroute_test_result_network_path_response'
4XX:
description: DEX traceroute test result network path failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/traceroute-tests/{test_id}:
get:
tags:
- Accounts
summary: Cloudflare Get details and aggregate metrics for a traceroute test
description: Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.
operationId: dex-endpoints-traceroute-test-details
parameters:
- name: account_id
in: path
description: Unique identifier linked to an account
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_id
in: path
description: Unique identifier for a specific test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
- name: timeStart
in: query
description: Start time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689520412000
- name: timeEnd
in: query
description: End time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689606812000
- name: interval
in: query
description: Time interval for aggregate time slots.
required: true
schema:
type: string
enum:
- minute
- hour
- name: colo
in: query
description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
schema:
type: string
responses:
'200':
description: DEX traceroute test details response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_traceroute_details_response'
4XX:
description: DEX traceroute test details response failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path:
get:
tags:
- Accounts
summary: Cloudflare Get network path breakdown for a traceroute test
description: Get a breakdown of metrics by hop for individual traceroute test runs
operationId: dex-endpoints-traceroute-test-network-path
parameters:
- name: account_id
in: path
description: unique identifier linked to an account
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_id
in: path
description: unique identifier for a specific test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
- name: deviceId
in: query
description: Device to filter tracroute result runs to
required: true
schema:
type: string
- name: timeStart
in: query
description: Start time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689520412000
- name: timeEnd
in: query
description: End time for aggregate metrics in ISO ms
required: true
schema:
type: string
example: 1689606812000
- name: interval
in: query
description: Time interval for aggregate time slots.
required: true
schema:
type: string
enum:
- minute
- hour
responses:
'200':
description: DEX traceroute test network path response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_traceroute_test_network_path_response'
4XX:
description: DEX traceroute test network path failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles:
get:
tags:
- Accounts
summary: Cloudflare Get percentiles for a traceroute test
description: Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.
operationId: dex-endpoints-traceroute-test-percentiles
parameters:
- name: account_id
in: path
description: unique identifier linked to an account in the API request path.
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_account_identifier'
- name: test_id
in: path
description: unique identifier for a specific test
required: true
schema:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
- name: deviceId
in: query
description: Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.
schema:
type: array
items:
type: string
- name: timeStart
in: query
description: Start time for aggregate metrics in ISO format
required: true
schema:
type: string
example: '2023-09-20T17:00:00Z'
- name: timeEnd
in: query
description: End time for aggregate metrics in ISO format
required: true
schema:
type: string
example: '2023-09-20T17:00:00Z'
- name: colo
in: query
description: Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.
schema:
type: string
responses:
'200':
description: DEX Traceroute test percentiles response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- properties:
result:
$ref: '#/components/schemas/digital-experience-monitoring_traceroute_details_percentiles_response'
4XX:
description: DEX Traceroute test percentiles failure response
content:
application/json:
schema:
$ref: '#/components/schemas/digital-experience-monitoring_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/diagnostics/traceroute:
post:
tags:
- Accounts
summary: Cloudflare Traceroute
description: Run traceroutes from Cloudflare colos.
operationId: diagnostics-traceroute
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-transit_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- targets
properties:
colos:
$ref: '#/components/schemas/magic-transit_colos'
options:
$ref: '#/components/schemas/magic-transit_options'
targets:
$ref: '#/components/schemas/magic-transit_targets'
responses:
'200':
description: Traceroute response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-transit_traceroute_response_collection'
4XX:
description: Traceroute response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-transit_traceroute_response_collection'
- $ref: '#/components/schemas/magic-transit_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/dlp/datasets:
get:
tags:
- Accounts
summary: Cloudflare Fetch all datasets with information about available versions.
description: Fetch all datasets with information about available versions.
operationId: dlp-datasets-read-all
parameters:
- name: account_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Datasets read successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetArrayResponse'
4XX:
description: Datasets read failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create a new dataset.
description: Create a new dataset.
operationId: dlp-datasets-create
parameters:
- name: account_id
in: path
required: true
schema:
type: string
requestBody:
description: Dataset description
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_NewDataset'
responses:
'200':
description: Dataset created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetCreationResponse'
4XX:
description: Dataset creation failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/datasets/{dataset_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a dataset.
description: 'Delete a dataset.
This deletes all versions of the dataset.'
operationId: dlp-datasets-delete
parameters:
- name: account_id
in: path
required: true
schema:
type: string
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Dataset deleted successfully
4XX:
description: Dataset delete failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Fetch a specific dataset with information about available versions.
description: Fetch a specific dataset with information about available versions.
operationId: dlp-datasets-read
parameters:
- name: account_id
in: path
required: true
schema:
type: string
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Dataset read successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetResponse'
4XX:
description: Dataset read failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update details about a dataset.
description: Update details about a dataset.
operationId: dlp-datasets-update
parameters:
- name: account_id
in: path
required: true
schema:
type: string
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
description: Dataset description
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetUpdate'
responses:
'200':
description: Dataset updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetResponse'
4XX:
description: Dataset update failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/datasets/{dataset_id}/upload:
post:
tags:
- Accounts
summary: Cloudflare Prepare to upload a new version of a dataset.
description: Prepare to upload a new version of a dataset.
operationId: dlp-datasets-create-version
parameters:
- name: account_id
in: path
required: true
schema:
type: string
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Dataset version created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetNewVersionResponse'
4XX:
description: Dataset version creation failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}:
post:
tags:
- Accounts
summary: Cloudflare Upload a new version of a dataset.
description: Upload a new version of a dataset.
operationId: dlp-datasets-upload-version
parameters:
- name: account_id
in: path
required: true
schema:
type: string
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
- name: version
in: path
required: true
schema:
type: integer
format: int64
requestBody:
description: Dataset. For custom wordlists this contains UTF-8 patterns separated by newline characters.
required: true
content:
application/octet-stream:
schema:
type: string
responses:
'200':
description: Dataset version uploaded successfully
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_DatasetResponse'
4XX:
description: Dataset version upload failed
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_V4ResponseError'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/patterns/validate:
post:
tags:
- Accounts
summary: Cloudflare Validate pattern
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_validate_pattern'
responses:
'200':
description: Validate pattern response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_validate_response'
4XX:
description: Validate pattern response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_validate_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/payload_log:
get:
tags:
- Accounts
summary: Cloudflare Get settings
description: Gets the current DLP payload log settings for this account.
operationId: dlp-payload-log-settings-get-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
responses:
'200':
description: Get settings response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_get_settings_response'
4XX:
description: Get settings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_get_settings_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update settings
description: Updates the DLP payload log settings for this account.
operationId: dlp-payload-log-settings-update-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_update_settings'
responses:
'200':
description: Update settings response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_update_settings_response'
4XX:
description: Update settings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_update_settings_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/profiles:
get:
tags:
- Accounts
summary: Cloudflare List all profiles
description: Lists all DLP profiles in an account.
operationId: dlp-profiles-list-all-profiles
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
responses:
'200':
description: List all profiles response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_response_collection'
4XX:
description: List all profiles response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_response_collection'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/profiles/{profile_id}:
get:
tags:
- Accounts
summary: Cloudflare Get DLP Profile
description: Fetches a DLP profile by ID. Supports both predefined and custom profiles
operationId: dlp-profiles-get-dlp-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
responses:
'200':
description: Get DLP Profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_either_profile_response'
4XX:
description: Get DLP Profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_either_profile_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/profiles/custom:
post:
tags:
- Accounts
summary: Cloudflare Create custom profiles
description: Creates a set of DLP custom profiles.
operationId: dlp-profiles-create-custom-profiles
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_create_custom_profiles'
responses:
'200':
description: Create custom profiles response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_create_custom_profile_response'
4XX:
description: Create custom profiles response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_create_custom_profile_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/profiles/custom/{profile_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete custom profile
description: Deletes a DLP custom profile.
operationId: dlp-profiles-delete-custom-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete custom profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_api-response-single'
4XX:
description: Delete custom profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Get custom profile
description: Fetches a custom DLP profile.
operationId: dlp-profiles-get-custom-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
responses:
'200':
description: Get custom profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_custom_profile_response'
4XX:
description: Get custom profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_custom_profile_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update custom profile
description: Updates a DLP custom profile.
operationId: dlp-profiles-update-custom-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_update_custom_profile'
responses:
'200':
description: Update custom profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_custom_profile'
4XX:
description: Update custom profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_custom_profile'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dlp/profiles/predefined/{profile_id}:
get:
tags:
- Accounts
summary: Cloudflare Get predefined profile
description: Fetches a predefined DLP profile.
operationId: dlp-profiles-get-predefined-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
responses:
'200':
description: Get predefined profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_predefined_profile_response'
4XX:
description: Get predefined profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_predefined_profile_response'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update predefined profile
description: Updates a DLP predefined profile. Only supports enabling/disabling entries.
operationId: dlp-profiles-update-predefined-profile
parameters:
- name: profile_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_profile_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dlp_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_update_predefined_profile'
responses:
'200':
description: Update predefined profile response
content:
application/json:
schema:
$ref: '#/components/schemas/dlp_predefined_profile'
4XX:
description: Update predefined profile response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
- $ref: '#/components/schemas/dlp_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/dns_firewall:
get:
tags:
- Accounts
summary: Cloudflare List DNS Firewall Clusters
description: List configured DNS Firewall clusters for an account.
operationId: dns-firewall-list-dns-firewall-clusters
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Number of clusters per page.
default: 20
minimum: 1
maximum: 100
responses:
'200':
description: List DNS Firewall Clusters response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
4XX:
description: List DNS Firewall Clusters response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
- $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create DNS Firewall Cluster
description: Create a configured DNS Firewall Cluster.
operationId: dns-firewall-create-dns-firewall-cluster
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- upstream_ips
properties:
attack_mitigation:
$ref: '#/components/schemas/dns-firewall_attack_mitigation'
deprecate_any_requests:
$ref: '#/components/schemas/dns-firewall_deprecate_any_requests'
ecs_fallback:
$ref: '#/components/schemas/dns-firewall_ecs_fallback'
maximum_cache_ttl:
$ref: '#/components/schemas/dns-firewall_maximum_cache_ttl'
minimum_cache_ttl:
$ref: '#/components/schemas/dns-firewall_minimum_cache_ttl'
name:
$ref: '#/components/schemas/dns-firewall_name'
negative_cache_ttl:
$ref: '#/components/schemas/dns-firewall_negative_cache_ttl'
origin_ips:
description: Deprecated alias for "upstream_ips".
deprecated: true
ratelimit:
$ref: '#/components/schemas/dns-firewall_ratelimit'
retries:
$ref: '#/components/schemas/dns-firewall_retries'
upstream_ips:
$ref: '#/components/schemas/dns-firewall_upstream_ips'
responses:
'200':
description: Create DNS Firewall Cluster response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
4XX:
description: Create DNS Firewall Cluster response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
- $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/dns_firewall/{dns_firewall_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete DNS Firewall Cluster
description: Delete a configured DNS Firewall Cluster.
operationId: dns-firewall-delete-dns-firewall-cluster
parameters:
- name: dns_firewall_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete DNS Firewall Cluster response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-single'
- properties:
result:
properties:
id:
$ref: '#/components/schemas/dns-firewall_identifier'
4XX:
description: Delete DNS Firewall Cluster response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-single'
- properties:
result:
properties:
id:
$ref: '#/components/schemas/dns-firewall_identifier'
- $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare DNS Firewall Cluster Details
description: Show a single configured DNS Firewall cluster for an account.
operationId: dns-firewall-dns-firewall-cluster-details
parameters:
- name: dns_firewall_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
responses:
'200':
description: DNS Firewall Cluster Details response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
4XX:
description: DNS Firewall Cluster Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
- $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update DNS Firewall Cluster
description: Modify a DNS Firewall Cluster configuration.
operationId: dns-firewall-update-dns-firewall-cluster
parameters:
- name: dns_firewall_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/dns-firewall_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/dns-firewall_schemas-dns-firewall'
responses:
'200':
description: Update DNS Firewall Cluster response
content:
application/json:
schema:
$ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
4XX:
description: Update DNS Firewall Cluster response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
- $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway:
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust account information
description: Gets information about the current Zero Trust account.
operationId: zero-trust-accounts-get-zero-trust-account-information
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust account information response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway_account'
4XX:
description: Get Zero Trust account information response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Zero Trust account
description: Creates a Zero Trust account with an existing Cloudflare account.
operationId: zero-trust-accounts-create-zero-trust-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Create Zero Trust account response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway_account'
4XX:
description: Create Zero Trust account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/app_types:
get:
tags:
- Accounts
summary: Cloudflare List application and application type mappings
description: Fetches all application and application type mappings.
operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-identifier'
responses:
'200':
description: List application and application type mappings response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection'
4XX:
description: List application and application type mappings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/audit_ssh_settings:
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust Audit SSH settings
description: Get all Zero Trust Audit SSH settings for an account.
operationId: zero-trust-get-audit-ssh-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust Audit SSH settings response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
4XX:
description: Get Zero Trust Audit SSH Settings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Zero Trust Audit SSH settings
description: Updates Zero Trust Audit SSH settings.
operationId: zero-trust-update-audit-ssh-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- public_key
properties:
public_key:
$ref: '#/components/schemas/zero-trust-gateway_public_key'
seed_id:
$ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-uuid'
responses:
'200':
description: Update Zero Trust Audit SSH Setting response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
4XX:
description: Update Zero Trust Audit SSH Setting response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/categories:
get:
tags:
- Accounts
summary: Cloudflare List categories
description: Fetches a list of all categories.
operationId: zero-trust-gateway-categories-list-categories
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-identifier'
responses:
'200':
description: List categories response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
4XX:
description: List categories response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/configuration:
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust account configuration
description: Fetches the current Zero Trust account configuration.
operationId: zero-trust-accounts-get-zero-trust-account-configuration
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
4XX:
description: Get Zero Trust account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Zero Trust account configuration
description: Patches the current Zero Trust account configuration. This endpoint can update a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `custom_certificate`, without updating the entire configuration object. Returns an error if any collection of settings is not properly configured.
operationId: zero-trust-accounts-patch-zero-trust-account-configuration
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
responses:
'200':
description: Update Zero Trust account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
4XX:
description: Update Zero Trust account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Zero Trust account configuration
description: Updates the current Zero Trust account configuration.
operationId: zero-trust-accounts-update-zero-trust-account-configuration
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
responses:
'200':
description: Update Zero Trust account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
4XX:
description: Update Zero Trust account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/lists:
get:
tags:
- Accounts
summary: Cloudflare List Zero Trust lists
description: Fetches all Zero Trust lists for an account.
operationId: zero-trust-lists-list-zero-trust-lists
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: List Zero Trust lists response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_response_collection'
4XX:
description: List Zero Trust lists response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Zero Trust list
description: Creates a new Zero Trust list.
operationId: zero-trust-lists-create-zero-trust-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- type
properties:
description:
$ref: '#/components/schemas/zero-trust-gateway_description'
items:
$ref: '#/components/schemas/zero-trust-gateway_items'
name:
$ref: '#/components/schemas/zero-trust-gateway_name'
type:
$ref: '#/components/schemas/zero-trust-gateway_type'
responses:
'200':
description: Create Zero Trust list response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_single_response_with_list_items'
4XX:
description: Create Zero Trust list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_single_response_with_list_items'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/lists/{list_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Zero Trust list
description: Deletes a Zero Trust list.
operationId: zero-trust-lists-delete-zero-trust-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Zero Trust list response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_empty_response'
4XX:
description: Delete Zero Trust list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_empty_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust list details
description: Fetches a single Zero Trust list.
operationId: zero-trust-lists-zero-trust-list-details
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust list details response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_single_response'
4XX:
description: Get Zero Trust list details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Zero Trust list
description: Appends or removes an item from a configured Zero Trust list.
operationId: zero-trust-lists-patch-zero-trust-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
append:
$ref: '#/components/schemas/zero-trust-gateway_items'
remove:
type: array
description: A list of the item values you want to remove.
items:
$ref: '#/components/schemas/zero-trust-gateway_value'
responses:
'200':
description: Patch Zero Trust list response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_single_response'
4XX:
description: Patch Zero Trust list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Zero Trust list
description: Updates a configured Zero Trust list.
operationId: zero-trust-lists-update-zero-trust-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
properties:
description:
$ref: '#/components/schemas/zero-trust-gateway_description'
name:
$ref: '#/components/schemas/zero-trust-gateway_name'
responses:
'200':
description: Update Zero Trust list response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_single_response'
4XX:
description: Update Zero Trust list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/lists/{list_id}/items:
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust list items
description: Fetches all items in a single Zero Trust list.
operationId: zero-trust-lists-zero-trust-list-items
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust list items response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_list_item_response_collection'
4XX:
description: Get Zero Trust list items response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_list_item_response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/locations:
get:
tags:
- Accounts
summary: Cloudflare List Zero Trust Gateway locations
description: Fetches Zero Trust Gateway locations for an account.
operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: List Zero Trust Gateway locations response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection'
4XX:
description: List Zero Trust Gateway locations response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_schemas-response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Zero Trust Gateway location
description: Creates a new Zero Trust Gateway location.
operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
properties:
client_default:
$ref: '#/components/schemas/zero-trust-gateway_client-default'
ecs_support:
$ref: '#/components/schemas/zero-trust-gateway_ecs-support'
name:
$ref: '#/components/schemas/zero-trust-gateway_schemas-name'
networks:
$ref: '#/components/schemas/zero-trust-gateway_networks'
responses:
'200':
description: Create a Zero Trust Gateway location response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
4XX:
description: Create a Zero Trust Gateway location response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/locations/{location_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Zero Trust Gateway location
description: Deletes a configured Zero Trust Gateway location.
operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location
parameters:
- name: location_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a Zero Trust Gateway location response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_empty_response'
4XX:
description: Delete a Zero Trust Gateway location response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_empty_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust Gateway location details
description: Fetches a single Zero Trust Gateway location.
operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details
parameters:
- name: location_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust Gateway location details response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
4XX:
description: Get Zero Trust Gateway location details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Zero Trust Gateway location
description: Updates a configured Zero Trust Gateway location.
operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location
parameters:
- name: location_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
properties:
client_default:
$ref: '#/components/schemas/zero-trust-gateway_client-default'
ecs_support:
$ref: '#/components/schemas/zero-trust-gateway_ecs-support'
name:
$ref: '#/components/schemas/zero-trust-gateway_schemas-name'
networks:
$ref: '#/components/schemas/zero-trust-gateway_networks'
responses:
'200':
description: Update a Zero Trust Gateway location response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
4XX:
description: Update a Zero Trust Gateway location response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/logging:
get:
tags:
- Accounts
summary: Cloudflare Get logging settings for the Zero Trust account
description: Fetches the current logging settings for Zero Trust account.
operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get logging settings for the Zero Trust account response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
4XX:
description: Get logging settings for the Zero Trust account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Zero Trust account logging settings
description: Updates logging settings for the current Zero Trust account.
operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
responses:
'200':
description: Update logging settings for the Zero Trust account response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
4XX:
description: Update logging settings for the Zero Trust account response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/proxy_endpoints:
get:
tags:
- Accounts
summary: Cloudflare Get a proxy endpoint
description: Fetches a single Zero Trust Gateway proxy endpoint.
operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get a proxy endpoint response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
4XX:
description: Get a proxy endpoint response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a proxy endpoint
description: Creates a new Zero Trust Gateway proxy endpoint.
operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- ips
properties:
ips:
$ref: '#/components/schemas/zero-trust-gateway_ips'
name:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
subdomain:
$ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
responses:
'200':
description: Create a proxy endpoint response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
4XX:
description: Create a proxy endpoint response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a proxy endpoint
description: Deletes a configured Zero Trust Gateway proxy endpoint.
operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint
parameters:
- name: proxy_endpoint_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a proxy endpoint response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_empty_response'
4XX:
description: Delete a proxy endpoint response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_empty_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List proxy endpoints
description: Fetches all Zero Trust Gateway proxy endpoints for an account.
operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details
parameters:
- name: proxy_endpoint_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: List proxy endpoints response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
4XX:
description: List proxy endpoints response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a proxy endpoint
description: Updates a configured Zero Trust Gateway proxy endpoint.
operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint
parameters:
- name: proxy_endpoint_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
ips:
$ref: '#/components/schemas/zero-trust-gateway_ips'
name:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
subdomain:
$ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
responses:
'200':
description: Update a proxy endpoint response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
4XX:
description: Update a proxy endpoint response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/rules:
get:
tags:
- Accounts
summary: Cloudflare List Zero Trust Gateway rules
description: Fetches the Zero Trust Gateway rules for an account.
operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: List Zero Trust Gateway rules response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
4XX:
description: List Zero Trust Gateway rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_components-schemas-response_collection'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Zero Trust Gateway rule
description: Creates a new Zero Trust Gateway rule.
operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- action
properties:
action:
$ref: '#/components/schemas/zero-trust-gateway_action'
description:
$ref: '#/components/schemas/zero-trust-gateway_schemas-description'
device_posture:
$ref: '#/components/schemas/zero-trust-gateway_device_posture'
enabled:
$ref: '#/components/schemas/zero-trust-gateway_enabled'
filters:
$ref: '#/components/schemas/zero-trust-gateway_filters'
identity:
$ref: '#/components/schemas/zero-trust-gateway_identity'
name:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
precedence:
$ref: '#/components/schemas/zero-trust-gateway_precedence'
rule_settings:
$ref: '#/components/schemas/zero-trust-gateway_rule-settings'
schedule:
$ref: '#/components/schemas/zero-trust-gateway_schedule'
traffic:
$ref: '#/components/schemas/zero-trust-gateway_traffic'
responses:
'200':
description: Create a Zero Trust Gateway rule response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
4XX:
description: Create a Zero Trust Gateway rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/gateway/rules/{rule_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Zero Trust Gateway rule
description: Deletes a Zero Trust Gateway rule.
operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a Zero Trust Gateway rule response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_empty_response'
4XX:
description: Delete a Zero Trust Gateway rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_empty_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust Gateway rule details
description: Fetches a single Zero Trust Gateway rule.
operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
responses:
'200':
description: Get Zero Trust Gateway rule details response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
4XX:
description: Get Zero Trust Gateway rule details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Zero Trust Gateway rule
description: Updates a configured Zero Trust Gateway rule.
operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/zero-trust-gateway_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- action
properties:
action:
$ref: '#/components/schemas/zero-trust-gateway_action'
description:
$ref: '#/components/schemas/zero-trust-gateway_schemas-description'
device_posture:
$ref: '#/components/schemas/zero-trust-gateway_device_posture'
enabled:
$ref: '#/components/schemas/zero-trust-gateway_enabled'
filters:
$ref: '#/components/schemas/zero-trust-gateway_filters'
identity:
$ref: '#/components/schemas/zero-trust-gateway_identity'
name:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
precedence:
$ref: '#/components/schemas/zero-trust-gateway_precedence'
rule_settings:
$ref: '#/components/schemas/zero-trust-gateway_rule-settings'
schedule:
$ref: '#/components/schemas/zero-trust-gateway_schedule'
traffic:
$ref: '#/components/schemas/zero-trust-gateway_traffic'
responses:
'200':
description: Update a Zero Trust Gateway rule response
content:
application/json:
schema:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
4XX:
description: Update a Zero Trust Gateway rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_components-schemas-single_response'
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/hyperdrive/configs:
get:
tags:
- Accounts
summary: Cloudflare List Hyperdrives
description: Returns a list of Hyperdrives
operationId: list-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
responses:
'200':
description: List Hyperdrives Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
4XX:
description: List Hyperdrives Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Hyperdrive
description: Creates and returns a new Hyperdrive configuration.
operationId: create-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config'
responses:
'200':
description: Create Hyperdrive Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- properties:
result:
$ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
4XX:
description: Create Hyperdrive Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Hyperdrive
description: Deletes the specified Hyperdrive.
operationId: delete-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
- name: hyperdrive_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
responses:
'200':
description: Delete Hyperdrive Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- properties:
result:
type: object
nullable: true
4XX:
description: Delete Hyperdrive Failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Hyperdrive
description: Returns the specified Hyperdrive configuration.
operationId: get-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
- name: hyperdrive_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
responses:
'200':
description: Get Hyperdrive Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- properties:
result:
$ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
4XX:
description: Get Hyperdrive Failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Hyperdrive
description: Patches and returns the specified Hyperdrive configuration. Updates to the origin and caching settings are applied with an all-or-nothing approach.
operationId: patch-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
- name: hyperdrive_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/hyperdrive_patch-hyperdrive-config'
responses:
'200':
description: Patch Hyperdrive Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- properties:
result:
$ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
4XX:
description: Patch Hyperdrive Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Hyperdrive
description: Updates and returns the specified Hyperdrive configuration.
operationId: update-hyperdrive
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
- name: hyperdrive_id
in: path
required: true
schema:
$ref: '#/components/schemas/hyperdrive_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/hyperdrive_create-update-hyperdrive-config'
responses:
'200':
description: Update Hyperdrive Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- properties:
result:
$ref: '#/components/schemas/hyperdrive_hyperdrive-with-identifier'
4XX:
description: Update Hyperdrive Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/hyperdrive_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1:
get:
tags:
- Accounts
summary: Cloudflare List images
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Number of items per page.
default: 1000
minimum: 10
maximum: 10000
responses:
'200':
description: List images response
content:
application/json:
schema:
$ref: '#/components/schemas/images_images_list_response'
4XX:
description: List images response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_images_list_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
deprecated: true
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Upload an image
description: 'Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.
An image can be uploaded by sending an image file or passing an accessible to an API url.
'
operationId: cloudflare-images-upload-an-image-via-url
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/images_image_basic_upload'
responses:
'200':
description: Upload an image response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_response_single'
4XX:
description: Upload an image response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_response_single'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/{image_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete image
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:
- name: image_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete image response
content:
application/json:
schema:
$ref: '#/components/schemas/images_deleted_response'
4XX:
description: Delete image response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_deleted_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Image details
description: Fetch details for a single image.
operationId: cloudflare-images-image-details
parameters:
- name: image_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Image details response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_response_single'
4XX:
description: Image details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_response_single'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update image
description: Update image access control. On access control change, all copies of the image are purged from cache.
operationId: cloudflare-images-update-image
parameters:
- name: image_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_patch_request'
responses:
'200':
description: Update image response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_response_single'
4XX:
description: Update image response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_response_single'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/{image_id}/blob:
get:
tags:
- Accounts
summary: Cloudflare Base image
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:
- name: image_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Base image response. Returns uploaded image data.
content:
image/*:
schema:
type: string
format: binary
4XX:
description: Base image response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_response_blob'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/keys:
get:
tags:
- Accounts
summary: Cloudflare List Signing Keys
description: Lists your signing keys. These can be found on your Cloudflare Images dashboard.
operationId: cloudflare-images-keys-list-signing-keys
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: List Signing Keys response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_key_response_collection'
4XX:
description: List Signing Keys response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_key_response_collection'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/keys/{signing_key_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Signing Key
description: 'Delete signing key with specified name. Returns all keys available.
When last key is removed, a new default signing key will be generated.
'
operationId: cloudflare-images-keys-delete-signing-key
parameters:
- name: signing_key_name
in: path
required: true
schema:
$ref: '#/components/schemas/images_signing_key_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Delete Signing Key response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_key_response_collection'
4XX:
description: Delete Signing Key response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_key_response_collection'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Create a new Signing Key
description: Create a new signing key with specified name. Returns all keys available.
operationId: cloudflare-images-keys-add-signing-key
parameters:
- name: signing_key_name
in: path
required: true
schema:
$ref: '#/components/schemas/images_signing_key_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Add Signing Key response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_key_response_collection'
4XX:
description: Add Signing Key response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_key_response_collection'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/stats:
get:
tags:
- Accounts
summary: Cloudflare Images usage statistics
description: Fetch usage statistics details for Cloudflare Images.
operationId: cloudflare-images-images-usage-statistics
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Images usage statistics response
content:
application/json:
schema:
$ref: '#/components/schemas/images_images_stats_response'
4XX:
description: Images usage statistics response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_images_stats_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/variants:
get:
tags:
- Accounts
summary: Cloudflare List variants
description: Lists existing variants.
operationId: cloudflare-images-variants-list-variants
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: List variants response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_list_response'
4XX:
description: List variants response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_variant_list_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a variant
description: Specify variants that allow you to resize images for different use cases.
operationId: cloudflare-images-variants-create-a-variant
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_definition'
responses:
'200':
description: Create a variant response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_simple_response'
4XX:
description: Create a variant response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_variant_simple_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v1/variants/{variant_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a variant
description: Deleting a variant purges the cache for all images associated with the variant.
operationId: cloudflare-images-variants-delete-a-variant
parameters:
- name: variant_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_variant_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a variant response
content:
application/json:
schema:
$ref: '#/components/schemas/images_deleted_response'
4XX:
description: Delete a variant response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_deleted_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Variant details
description: Fetch details for a single variant.
operationId: cloudflare-images-variants-variant-details
parameters:
- name: variant_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_variant_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
responses:
'200':
description: Variant details response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_simple_response'
4XX:
description: Variant details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_variant_simple_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a variant
description: Updating a variant purges the cache for all images associated with the variant.
operationId: cloudflare-images-variants-update-a-variant
parameters:
- name: variant_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_image_variant_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_patch_request'
responses:
'200':
description: Update a variant response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_variant_simple_response'
4XX:
description: Update a variant response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_variant_simple_response'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v2:
get:
tags:
- Accounts
summary: Cloudflare List images V2
description: 'List up to 10000 images with one request. Use the optional parameters below to get a specific range of images.
Endpoint returns continuation_token if more images are present.
'
operationId: cloudflare-images-list-images-v2
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
- name: continuation_token
in: query
schema:
type: string
description: Continuation token for a next page. List images V2 returns continuation_token
nullable: true
- name: per_page
in: query
schema:
type: number
description: Number of items per page.
default: 1000
minimum: 10
maximum: 10000
- name: sort_order
in: query
schema:
type: string
description: Sorting order by upload time.
enum:
- asc
- desc
default: desc
responses:
'200':
description: List images response
content:
application/json:
schema:
$ref: '#/components/schemas/images_images_list_response_v2'
4XX:
description: List images response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_images_list_response_v2'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/images/v2/direct_upload:
post:
tags:
- Accounts
summary: Cloudflare Create authenticated direct upload URL V2
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/images_account_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/images_image_direct_upload_request_v2'
responses:
'200':
description: Create authenticated direct upload URL V2 response
content:
application/json:
schema:
$ref: '#/components/schemas/images_image_direct_upload_response_v2'
4XX:
description: Create authenticated direct upload URL V2 response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/images_image_direct_upload_response_v2'
- $ref: '#/components/schemas/images_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/asn/{asn}:
get:
tags:
- Accounts
summary: Cloudflare Get ASN Overview
operationId: asn-intelligence-get-asn-overview
parameters:
- name: asn
in: path
required: true
schema:
$ref: '#/components/schemas/intel_asn'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
responses:
'200':
description: Get ASN Overview response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_asn_components-schemas-response'
4XX:
description: Get ASN Overview response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_asn_components-schemas-response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/asn/{asn}/subnets:
get:
tags:
- Accounts
summary: Cloudflare Get ASN Subnets
operationId: asn-intelligence-get-asn-subnets
parameters:
- name: asn
in: path
required: true
schema:
$ref: '#/components/schemas/intel_asn'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
responses:
'200':
description: Get ASN Subnets response
content:
application/json:
schema:
type: object
properties:
asn:
$ref: '#/components/schemas/intel_asn'
count:
$ref: '#/components/schemas/intel_count'
ip_count_total:
type: integer
page:
$ref: '#/components/schemas/intel_page'
per_page:
$ref: '#/components/schemas/intel_per_page'
subnets:
type: array
example:
- 192.0.2.0/24
- 2001:DB8::/32
items:
type: string
4XX:
description: Get ASN Subnets response failure
content:
application/json:
schema:
allOf:
- type: object
properties:
asn:
$ref: '#/components/schemas/intel_asn'
count:
$ref: '#/components/schemas/intel_count'
ip_count_total:
type: integer
page:
$ref: '#/components/schemas/intel_page'
per_page:
$ref: '#/components/schemas/intel_per_page'
subnets:
type: array
example:
- 192.0.2.0/24
- 2001:DB8::/32
items:
type: string
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss:
put:
tags:
- Accounts
summary: Cloudflare Archive Security Center Insight
operationId: archive-security-center-insight
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
- name: issue_id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dismiss:
type: boolean
default: true
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/security-center_api-response-single'
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/attack-surface-report/issue-types:
get:
tags:
- Accounts
summary: Cloudflare Get Security Center Issues Types
operationId: get-security-center-issue-types
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/security-center_api-response-common'
- properties:
result:
anyOf:
- type: array
items:
type: string
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/attack-surface-report/issues:
get:
tags:
- Accounts
summary: Cloudflare Get Security Center Issues
operationId: get-security-center-issues
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
- name: dismissed
in: query
schema:
$ref: '#/components/schemas/security-center_dismissed'
- name: issue_class
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
- name: issue_class~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product~neq
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity~neq
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject~neq
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
- name: page
in: query
schema:
allOf:
- $ref: '#/components/schemas/security-center_page'
default: 1
- name: per_page
in: query
schema:
allOf:
- $ref: '#/components/schemas/security-center_perPage'
default: 25
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/security-center_api-response-common'
- properties:
result:
anyOf:
- type: object
properties:
count:
$ref: '#/components/schemas/security-center_count'
issues:
type: array
items:
$ref: '#/components/schemas/security-center_issue'
page:
$ref: '#/components/schemas/security-center_page'
per_page:
$ref: '#/components/schemas/security-center_perPage'
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/attack-surface-report/issues/class:
get:
tags:
- Accounts
summary: Cloudflare Get Security Center Issue Counts by Class
operationId: get-security-center-issue-counts-by-class
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
- name: dismissed
in: query
schema:
$ref: '#/components/schemas/security-center_dismissed'
- name: issue_class
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
- name: issue_class~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product~neq
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity~neq
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject~neq
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_valueCountsResponse'
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/attack-surface-report/issues/severity:
get:
tags:
- Accounts
summary: Cloudflare Get Security Center Issue Counts by Severity
operationId: get-security-center-issue-counts-by-severity
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
- name: dismissed
in: query
schema:
$ref: '#/components/schemas/security-center_dismissed'
- name: issue_class
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
- name: issue_class~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product~neq
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity~neq
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject~neq
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_valueCountsResponse'
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/attack-surface-report/issues/type:
get:
tags:
- Accounts
summary: Cloudflare Get Security Center Issue Counts by Type
operationId: get-security-center-issue-counts-by-type
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/security-center_identifier'
- name: dismissed
in: query
schema:
$ref: '#/components/schemas/security-center_dismissed'
- name: issue_class
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
- name: issue_class~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueClasses'
- name: issue_type~neq
in: query
schema:
$ref: '#/components/schemas/security-center_issueTypes'
- name: product~neq
in: query
schema:
$ref: '#/components/schemas/security-center_products'
- name: severity~neq
in: query
schema:
$ref: '#/components/schemas/security-center_severityQueryParam'
- name: subject~neq
in: query
schema:
$ref: '#/components/schemas/security-center_subjects'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_valueCountsResponse'
4XX:
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/security-center_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_id}/intel/dns:
get:
tags:
- Accounts
summary: Cloudflare Get Passive DNS by IP
operationId: passive-dns-by-ip-get-passive-dns-by-ip
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: start_end_params
in: query
schema:
$ref: '#/components/schemas/intel_start_end_params'
- name: ipv4
in: query
schema:
type: string
- name: page
in: query
schema:
type: number
description: Requested page within paginated list of results.
example: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results requested.
example: 20
responses:
'200':
description: Get Passive DNS by IP response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_components-schemas-single_response'
4XX:
description: Get Passive DNS by IP response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_components-schemas-single_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/domain:
get:
tags:
- Accounts
summary: Cloudflare Get Domain Details
operationId: domain-intelligence-get-domain-details
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: domain
in: query
schema:
type: string
responses:
'200':
description: Get Domain Details response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_single_response'
4XX:
description: Get Domain Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_single_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/domain-history:
get:
tags:
- Accounts
summary: Cloudflare Get Domain History
operationId: domain-history-get-domain-history
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: domain
in: query
schema:
example: example.com
responses:
'200':
description: Get Domain History response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_response'
4XX:
description: Get Domain History response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/domain/bulk:
get:
tags:
- Accounts
summary: Cloudflare Get Multiple Domain Details
operationId: domain-intelligence-get-multiple-domain-details
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: domain
in: query
schema:
description: Accepts multiple values, i.e. `?domain=cloudflare.com&domain=example.com`.
responses:
'200':
description: Get Multiple Domain Details response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_collection_response'
4XX:
description: Get Multiple Domain Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_collection_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds:
get:
tags:
- Accounts
summary: Cloudflare Get indicator feeds owned by this account
operationId: custom-indicator-feeds-get-indicator-feeds
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
responses:
'200':
description: Get indicator feeds response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_indicator_feed_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_indicator_feed_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create new indicator feed
operationId: custom-indicator-feeds-create-indicator-feeds
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intel_create_feed'
responses:
'200':
description: Create indicator feed response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_create_feed_response'
4XX:
description: Get indicator feeds failure response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_create_feed_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/{feed_id}:
get:
tags:
- Accounts
summary: Cloudflare Get indicator feed metadata
operationId: custom-indicator-feeds-get-indicator-feed-metadata
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: feed_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_feed_id'
responses:
'200':
description: Get indicator feed metadata
content:
application/json:
schema:
$ref: '#/components/schemas/intel_indicator_feed_metadata_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_indicator_feed_metadata_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/{feed_id}/data:
get:
tags:
- Accounts
summary: Cloudflare Get indicator feed data
operationId: custom-indicator-feeds-get-indicator-feed-data
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: feed_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_feed_id'
responses:
'200':
description: Get indicator feed metadata
content:
text/csv:
schema:
type: string
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot:
put:
tags:
- Accounts
summary: Cloudflare Update indicator feed data
operationId: custom-indicator-feeds-update-indicator-feed-data
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: feed_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_feed_id'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
source:
type: string
description: The file to upload
example: '@/Users/me/test.stix2'
responses:
'200':
description: Get indicator feed metadata
content:
application/json:
schema:
$ref: '#/components/schemas/intel_update_feed_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/permissions/add:
put:
tags:
- Accounts
summary: Cloudflare Grant permission to indicator feed
operationId: custom-indicator-feeds-add-permission
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intel_permissions-request'
responses:
'200':
description: Get indicator feed metadata
content:
application/json:
schema:
$ref: '#/components/schemas/intel_permissions_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_permissions_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/permissions/remove:
put:
tags:
- Accounts
summary: Cloudflare Revoke permission to indicator feed
operationId: custom-indicator-feeds-remove-permission
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intel_permissions-request'
responses:
'200':
description: Get indicator feed metadata
content:
application/json:
schema:
$ref: '#/components/schemas/intel_permissions_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_permissions_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/indicator-feeds/permissions/view:
get:
tags:
- Accounts
summary: Cloudflare List indicator feed permissions
operationId: custom-indicator-feeds-view-permissions
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
responses:
'200':
description: Get indicator feed metadata
content:
application/json:
schema:
$ref: '#/components/schemas/intel_permission_list_item_response'
4XX:
description: Get indicator feeds response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_permission_list_item_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/ip:
get:
tags:
- Accounts
summary: Cloudflare Get IP Overview
operationId: ip-intelligence-get-ip-overview
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: ipv4
in: query
schema:
type: string
- name: ipv6
in: query
schema:
type: string
responses:
'200':
description: Get IP Overview response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_schemas-response'
4XX:
description: Get IP Overview response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_schemas-response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/ip-list:
get:
tags:
- Accounts
summary: Cloudflare Get IP Lists
operationId: ip-list-get-ip-lists
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
responses:
'200':
description: Get IP Lists response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_components-schemas-response'
4XX:
description: Get IP Lists response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_components-schemas-response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/miscategorization:
post:
tags:
- Accounts
summary: Cloudflare Create Miscategorization
operationId: miscategorization-create-miscategorization
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intel_miscategorization'
responses:
'200':
description: Create Miscategorization response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_api-response-single'
4XX:
description: Create Miscategorization response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/intel/sinkholes:
get:
tags:
- Accounts
summary: Cloudflare List sinkholes owned by this account
operationId: sinkhole-config-get-sinkholes
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel-sinkholes_identifier'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/intel-sinkholes_get_sinkholes_response'
security:
- api_email: []
api_key: []
/accounts/{account_id}/intel/whois:
get:
tags:
- Accounts
summary: Cloudflare Get WHOIS Record
operationId: whois-record-get-whois-record
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/intel_identifier'
- name: domain
in: query
schema:
type: string
responses:
'200':
description: Get WHOIS Record response
content:
application/json:
schema:
$ref: '#/components/schemas/intel_schemas-single_response'
4XX:
description: Get WHOIS Record response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/intel_schemas-single_response'
- $ref: '#/components/schemas/intel_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/load_balancers/monitors:
get:
tags:
- Accounts
summary: Cloudflare List Monitors
description: List configured monitors for an account.
operationId: account-load-balancer-monitors-list-monitors
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: List Monitors response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_monitor-response-collection'
4XX:
description: List Monitors response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-response-collection'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create Monitor
description: Create a configured monitor.
operationId: account-load-balancer-monitors-create-monitor
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- required:
- expected_codes
responses:
'200':
description: Create Monitor response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_monitor-response-single'
4XX:
description: Create Monitor response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-response-single'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/monitors/{monitor_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Monitor
description: Delete a configured monitor.
operationId: account-load-balancer-monitors-delete-monitor
parameters:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Monitor response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_id_response'
4XX:
description: Delete Monitor response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_id_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Monitor Details
description: List a single configured monitor for an account.
operationId: account-load-balancer-monitors-monitor-details
parameters:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: Monitor Details response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_monitor-response-single'
4XX:
description: Monitor Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-response-single'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Monitor
description: Apply changes to an existing monitor, overwriting the supplied properties.
operationId: account-load-balancer-monitors-patch-monitor
parameters:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- required:
- expected_codes
responses:
'200':
description: Patch Monitor response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_monitor-response-single'
4XX:
description: Patch Monitor response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-response-single'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update Monitor
description: Modify a configured monitor.
operationId: account-load-balancer-monitors-update-monitor
parameters:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- required:
- expected_codes
responses:
'200':
description: Update Monitor response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_monitor-response-single'
4XX:
description: Update Monitor response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-response-single'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview:
post:
tags:
- Accounts
summary: Cloudflare Preview Monitor
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:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- required:
- expected_codes
responses:
'200':
description: Preview Monitor response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_preview_response'
4XX:
description: Preview Monitor response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_preview_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/monitors/{monitor_id}/references:
get:
tags:
- Accounts
summary: Cloudflare List Monitor References
description: Get the list of resources that reference the provided monitor.
operationId: account-load-balancer-monitors-list-monitor-references
parameters:
- name: monitor_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: List Monitor References response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_references_response'
4XX:
description: List Monitor References response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_references_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/pools:
get:
tags:
- Accounts
summary: Cloudflare List Pools
description: List configured pools.
operationId: account-load-balancer-pools-list-pools
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
- name: monitor
in: query
schema:
description: The ID of the Monitor to use for checking the health of origins within this pool.
responses:
'200':
description: List Pools response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-response_collection'
4XX:
description: List Pools response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-response_collection'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Pools
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
notification_email:
$ref: '#/components/schemas/load-balancing_patch_pools_notification_email'
responses:
'200':
description: Patch Pools response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-response_collection'
4XX:
description: Patch Pools response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-response_collection'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create Pool
description: Create a new pool.
operationId: account-load-balancer-pools-create-pool
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- origins
- name
properties:
description:
$ref: '#/components/schemas/load-balancing_schemas-description'
enabled:
$ref: '#/components/schemas/load-balancing_enabled'
latitude:
$ref: '#/components/schemas/load-balancing_latitude'
load_shedding:
$ref: '#/components/schemas/load-balancing_load_shedding'
longitude:
$ref: '#/components/schemas/load-balancing_longitude'
minimum_origins:
$ref: '#/components/schemas/load-balancing_minimum_origins'
monitor:
$ref: '#/components/schemas/load-balancing_monitor_id'
name:
$ref: '#/components/schemas/load-balancing_name'
notification_email:
$ref: '#/components/schemas/load-balancing_notification_email'
notification_filter:
$ref: '#/components/schemas/load-balancing_notification_filter'
origin_steering:
$ref: '#/components/schemas/load-balancing_origin_steering'
origins:
$ref: '#/components/schemas/load-balancing_origins'
responses:
'200':
description: Create Pool response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-single_response'
4XX:
description: Create Pool response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-single_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/pools/{pool_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Pool
description: Delete a configured pool.
operationId: account-load-balancer-pools-delete-pool
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Pool response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-id_response'
4XX:
description: Delete Pool response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-id_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Pool Details
description: Fetch a single configured pool.
operationId: account-load-balancer-pools-pool-details
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: Pool Details response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-single_response'
4XX:
description: Pool Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-single_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Pool
description: Apply changes to an existing pool, overwriting the supplied properties.
operationId: account-load-balancer-pools-patch-pool
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
check_regions:
$ref: '#/components/schemas/load-balancing_check_regions'
description:
$ref: '#/components/schemas/load-balancing_schemas-description'
disabled_at:
$ref: '#/components/schemas/load-balancing_schemas-disabled_at'
enabled:
$ref: '#/components/schemas/load-balancing_enabled'
latitude:
$ref: '#/components/schemas/load-balancing_latitude'
load_shedding:
$ref: '#/components/schemas/load-balancing_load_shedding'
longitude:
$ref: '#/components/schemas/load-balancing_longitude'
minimum_origins:
$ref: '#/components/schemas/load-balancing_minimum_origins'
monitor:
$ref: '#/components/schemas/load-balancing_monitor_id'
name:
$ref: '#/components/schemas/load-balancing_name'
notification_email:
$ref: '#/components/schemas/load-balancing_notification_email'
notification_filter:
$ref: '#/components/schemas/load-balancing_notification_filter'
origin_steering:
$ref: '#/components/schemas/load-balancing_origin_steering'
origins:
$ref: '#/components/schemas/load-balancing_origins'
responses:
'200':
description: Patch Pool response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-single_response'
4XX:
description: Patch Pool response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-single_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update Pool
description: Modify a configured pool.
operationId: account-load-balancer-pools-update-pool
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- origins
- name
properties:
check_regions:
$ref: '#/components/schemas/load-balancing_check_regions'
description:
$ref: '#/components/schemas/load-balancing_schemas-description'
disabled_at:
$ref: '#/components/schemas/load-balancing_schemas-disabled_at'
enabled:
$ref: '#/components/schemas/load-balancing_enabled'
latitude:
$ref: '#/components/schemas/load-balancing_latitude'
load_shedding:
$ref: '#/components/schemas/load-balancing_load_shedding'
longitude:
$ref: '#/components/schemas/load-balancing_longitude'
minimum_origins:
$ref: '#/components/schemas/load-balancing_minimum_origins'
monitor:
$ref: '#/components/schemas/load-balancing_monitor_id'
name:
$ref: '#/components/schemas/load-balancing_name'
notification_email:
$ref: '#/components/schemas/load-balancing_notification_email'
notification_filter:
$ref: '#/components/schemas/load-balancing_notification_filter'
origin_steering:
$ref: '#/components/schemas/load-balancing_origin_steering'
origins:
$ref: '#/components/schemas/load-balancing_origins'
responses:
'200':
description: Update Pool response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-single_response'
4XX:
description: Update Pool response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-single_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/pools/{pool_id}/health:
get:
tags:
- Accounts
summary: Cloudflare Pool Health Details
description: Fetch the latest pool health status for a single pool.
operationId: account-load-balancer-pools-pool-health-details
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: Pool Health Details response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_health_details'
4XX:
description: Pool Health Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_health_details'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/pools/{pool_id}/preview:
post:
tags:
- Accounts
summary: Cloudflare Preview Pool
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:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- required:
- expected_codes
responses:
'200':
description: Preview Pool response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_preview_response'
4XX:
description: Preview Pool response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_preview_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/pools/{pool_id}/references:
get:
tags:
- Accounts
summary: Cloudflare List Pool References
description: Get the list of resources that reference the provided pool.
operationId: account-load-balancer-pools-list-pool-references
parameters:
- name: pool_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: List Pool References response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_schemas-references_response'
4XX:
description: List Pool References response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_schemas-references_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/preview/{preview_id}:
get:
tags:
- Accounts
summary: Cloudflare Preview Result
description: Get the result of a previous preview operation using the provided preview_id.
operationId: account-load-balancer-monitors-preview-result
parameters:
- name: preview_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_schemas-preview_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: Preview Result response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_preview_result_response'
4XX:
description: Preview Result response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_preview_result_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/regions:
get:
tags:
- Accounts
summary: Cloudflare List Regions
description: List all region mappings.
operationId: load-balancer-regions-list-regions
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
- name: subdivision_code
in: query
schema:
$ref: '#/components/schemas/load-balancing_subdivision_code_a2'
- name: subdivision_code_a2
in: query
schema:
$ref: '#/components/schemas/load-balancing_subdivision_code_a2'
- name: country_code_a2
in: query
schema:
type: string
description: Two-letter alpha-2 country code followed in ISO 3166-1.
example: US
responses:
'200':
description: List Regions response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection'
4XX:
description: List Regions response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_region_components-schemas-response_collection'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/regions/{region_id}:
get:
tags:
- Accounts
summary: Cloudflare Get Region
description: Get a single region mapping.
operationId: load-balancer-regions-get-region
parameters:
- name: region_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_region_code'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
responses:
'200':
description: Get Region response
content:
application/json:
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-single_response'
4XX:
description: Get Region response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_components-schemas-single_response'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/load_balancers/search:
get:
tags:
- Accounts
summary: Cloudflare Search Resources
description: Search for Load Balancing resources.
operationId: account-load-balancer-search-search-resources
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/load-balancing_components-schemas-identifier'
- name: search_params
in: query
schema:
$ref: '#/components/schemas/load-balancing_search_params'
- name: page
in: query
schema:
minimum: 1
- name: per_page
in: query
schema:
default: 25
minimum: 1
maximum: 1000
responses:
'200':
description: Search Resources response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- $ref: '#/components/schemas/load-balancing_search_result'
4XX:
description: Search Resources response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- $ref: '#/components/schemas/load-balancing_search_result'
- $ref: '#/components/schemas/load-balancing_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/logpush/datasets/{dataset_id}/fields:
get:
tags:
- Accounts
summary: Cloudflare List fields
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:
- name: dataset_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_dataset'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
responses:
'200':
description: List fields response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_field_response_collection'
4XX:
description: List fields response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_field_response_collection'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/datasets/{dataset_id}/jobs:
get:
tags:
- Accounts
summary: Cloudflare List Logpush jobs for a dataset
description: Lists Logpush jobs for an account for a dataset.
operationId: get-accounts-account_identifier-logpush-datasets-dataset-jobs
parameters:
- name: dataset_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_dataset'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
responses:
'200':
description: List Logpush jobs for a dataset response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_job_response_collection'
4XX:
description: List Logpush jobs for a dataset response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_job_response_collection'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/jobs:
get:
tags:
- Accounts
summary: Cloudflare List Logpush jobs
description: Lists Logpush jobs for an account.
operationId: get-accounts-account_identifier-logpush-jobs
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
responses:
'200':
description: List Logpush jobs response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_job_response_collection'
4XX:
description: List Logpush jobs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_job_response_collection'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Logpush job
description: Creates a new Logpush job for an account.
operationId: post-accounts-account_identifier-logpush-jobs
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- destination_conf
properties:
dataset:
$ref: '#/components/schemas/logpush_dataset'
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
enabled:
$ref: '#/components/schemas/logpush_enabled'
frequency:
$ref: '#/components/schemas/logpush_frequency'
logpull_options:
$ref: '#/components/schemas/logpush_logpull_options'
name:
$ref: '#/components/schemas/logpush_name'
output_options:
$ref: '#/components/schemas/logpush_output_options'
ownership_challenge:
$ref: '#/components/schemas/logpush_ownership_challenge'
responses:
'200':
description: Create Logpush job response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_job_response_single'
4XX:
description: Create Logpush job response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_job_response_single'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/jobs/{job_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Logpush job
description: Deletes a Logpush job.
operationId: delete-accounts-account_identifier-logpush-jobs-job_identifier
parameters:
- name: job_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Logpush job response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
example: {}
nullable: true
4XX:
description: Delete Logpush job response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
example: {}
nullable: true
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Logpush job details
description: Gets the details of a Logpush job.
operationId: get-accounts-account_identifier-logpush-jobs-job_identifier
parameters:
- name: job_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
responses:
'200':
description: Get Logpush job details response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_job_response_single'
4XX:
description: Get Logpush job details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_job_response_single'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Logpush job
description: Updates a Logpush job.
operationId: put-accounts-account_identifier-logpush-jobs-job_identifier
parameters:
- name: job_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
enabled:
$ref: '#/components/schemas/logpush_enabled'
frequency:
$ref: '#/components/schemas/logpush_frequency'
logpull_options:
$ref: '#/components/schemas/logpush_logpull_options'
output_options:
$ref: '#/components/schemas/logpush_output_options'
ownership_challenge:
$ref: '#/components/schemas/logpush_ownership_challenge'
responses:
'200':
description: Update Logpush job response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_logpush_job_response_single'
4XX:
description: Update Logpush job response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_logpush_job_response_single'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/ownership:
post:
tags:
- Accounts
summary: Cloudflare Get ownership challenge
description: Gets a new ownership challenge sent to your destination.
operationId: post-accounts-account_identifier-logpush-ownership
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- destination_conf
properties:
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
responses:
'200':
description: Get ownership challenge response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_get_ownership_response'
4XX:
description: Get ownership challenge response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_get_ownership_response'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/ownership/validate:
post:
tags:
- Accounts
summary: Cloudflare Validate ownership challenge
description: Validates ownership challenge of the destination.
operationId: post-accounts-account_identifier-logpush-ownership-validate
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- destination_conf
- ownership_challenge
properties:
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
ownership_challenge:
$ref: '#/components/schemas/logpush_ownership_challenge'
responses:
'200':
description: Validate ownership challenge response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_validate_ownership_response'
4XX:
description: Validate ownership challenge response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_validate_ownership_response'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/validate/destination/exists:
post:
tags:
- Accounts
summary: Cloudflare Check destination exists
description: Checks if there is an existing job with a destination.
operationId: delete-accounts-account_identifier-logpush-validate-destination-exists
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- destination_conf
properties:
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
responses:
'200':
description: Check destination exists response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_destination_exists_response'
4XX:
description: Check destination exists response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_destination_exists_response'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logpush/validate/origin:
post:
tags:
- Accounts
summary: Cloudflare Validate origin
description: Validates logpull origin with logpull_options.
operationId: post-accounts-account_identifier-logpush-validate-origin
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logpush_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- logpull_options
properties:
logpull_options:
$ref: '#/components/schemas/logpush_logpull_options'
responses:
'200':
description: Validate origin response
content:
application/json:
schema:
$ref: '#/components/schemas/logpush_validate_response'
4XX:
description: Validate origin response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logpush_validate_response'
- $ref: '#/components/schemas/logpush_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/logs/control/cmb/config:
delete:
tags:
- Accounts
summary: Cloudflare Delete CMB config
description: Deletes CMB config.
operationId: delete-accounts-account_identifier-logs-control-cmb-config
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logcontrol_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete CMB config response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logcontrol_api-response-common'
- properties:
result:
type: object
example: {}
nullable: true
4XX:
description: Delete CMB config response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/logcontrol_api-response-common'
- properties:
result:
type: object
example: {}
nullable: true
- $ref: '#/components/schemas/logcontrol_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get CMB config
description: Gets CMB config.
operationId: get-accounts-account_identifier-logs-control-cmb-config
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logcontrol_identifier'
responses:
'200':
description: Get CMB config response
content:
application/json:
schema:
$ref: '#/components/schemas/logcontrol_cmb_config_response_single'
4XX:
description: Get CMB config response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logcontrol_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Update CMB config
description: Updates CMB config.
operationId: put-accounts-account_identifier-logs-control-cmb-config
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/logcontrol_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/logcontrol_cmb_config'
responses:
'200':
description: Update CMB config response
content:
application/json:
schema:
$ref: '#/components/schemas/logcontrol_cmb_config_response_single'
4XX:
description: Update CMB config response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/logcontrol_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/members:
get:
tags:
- Accounts
summary: Cloudflare List Members
description: List all members of an account.
operationId: account-members-list-members
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
- name: order
in: query
schema:
description: Field to order results by.
enum:
- user.first_name
- user.last_name
- user.email
- status
example: status
- name: status
in: query
schema:
type: string
description: A member's status in the account.
enum:
- accepted
- pending
- rejected
example: accepted
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results per page.
default: 20
minimum: 5
maximum: 50
- name: direction
in: query
schema:
type: string
description: Direction to order results.
enum:
- asc
- desc
example: desc
responses:
'200':
description: List Members response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_collection_member_response'
4XX:
description: List Members response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_collection'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add Member
description: Add a user to the list of members for this account.
operationId: account-members-add-member
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/iam_create'
responses:
'200':
description: Add Member response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_single_member_response_with_code'
4XX:
description: Add Member response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/members/{member_id}:
delete:
tags:
- Accounts
summary: Cloudflare Remove Member
description: Remove a member from an account.
operationId: account-members-remove-member
parameters:
- name: member_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_membership_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Remove Member response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_api-response-single-id'
4XX:
description: Remove Member response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_api-response-single-id'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Member Details
description: Get information about a specific member of an account.
operationId: account-members-member-details
parameters:
- name: member_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_membership_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
responses:
'200':
description: Member Details response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_single_member_response'
4XX:
description: Member Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Member
description: Modify an account member.
operationId: account-members-update-member
parameters:
- name: member_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_membership_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/iam_schemas-member'
responses:
'200':
description: Update Member response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_single_member_response'
4XX:
description: Update Member response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/mtls_certificates:
get:
tags:
- Accounts
summary: Cloudflare List mTLS certificates
description: Lists all mTLS certificates.
operationId: m-tls-certificate-management-list-m-tls-certificates
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
responses:
'200':
description: List mTLS certificates response
content:
application/json:
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection'
4XX:
description: List mTLS certificates response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection'
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Upload mTLS certificate
description: Upload a certificate that you want to use with mTLS-enabled Cloudflare services.
operationId: m-tls-certificate-management-upload-m-tls-certificate
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- certificates
- ca
properties:
ca:
$ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
certificates:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
name:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
private_key:
$ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-private_key'
responses:
'200':
description: Upload mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post'
4XX:
description: Upload mTLS certificate response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post'
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete mTLS certificate
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:
- name: mtls_certificate_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
4XX:
description: Delete mTLS certificate response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get mTLS certificate
description: Fetches a single mTLS certificate.
operationId: m-tls-certificate-management-get-m-tls-certificate
parameters:
- name: mtls_certificate_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
responses:
'200':
description: Get mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
4XX:
description: Get mTLS certificate response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single'
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations:
get:
tags:
- Accounts
summary: Cloudflare List mTLS certificate associations
description: Lists all active associations between the certificate and Cloudflare services.
operationId: m-tls-certificate-management-list-m-tls-certificate-associations
parameters:
- name: mtls_certificate_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
responses:
'200':
description: List mTLS certificate associations response
content:
application/json:
schema:
$ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection'
4XX:
description: List mTLS certificate associations response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_association_response_collection'
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects:
get:
tags:
- Accounts
summary: Cloudflare Get projects
description: Fetch a list of all user projects.
operationId: pages-project-get-projects
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get projects response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_projects-response'
4XX:
description: Get projects response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_projects-response'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create project
description: Create a new project.
operationId: pages-project-create-project
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pages_projects'
responses:
'200':
description: Create project response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_new-project-response'
4XX:
description: Create project response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_new-project-response'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete project
description: Delete a project by name.
operationId: pages-project-delete-project
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete project response.
content:
application/json:
schema:
example:
errors: []
messages: []
result: null
success: true
4XX:
description: Delete project response failure.
content:
application/json:
schema:
allOf:
- example:
errors: []
messages: []
result: null
success: true
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get project
description: Fetch a project by name.
operationId: pages-project-get-project
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get project response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_project-response'
4XX:
description: Get project response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_project-response'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update project
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:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pages_project-patch'
responses:
'200':
description: Update project response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_new-project-response'
4XX:
description: Update project response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_new-project-response'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/deployments:
get:
tags:
- Accounts
summary: Cloudflare Get deployments
description: Fetch a list of project deployments.
operationId: pages-deployment-get-deployments
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get deployments response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-list-response'
4XX:
description: Get deployments response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-list-response'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create deployment
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:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
branch:
type: string
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
responses:
'200':
description: Create deployment response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-new-deployment'
4XX:
description: Create deployment response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-new-deployment'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete deployment
description: Delete a deployment.
operationId: pages-deployment-delete-deployment
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete deployment response.
content:
application/json:
schema:
example:
errors: []
messages: []
result: null
success: true
4XX:
description: Delete deployment response failure.
content:
application/json:
schema:
allOf:
- example:
errors: []
messages: []
result: null
success: true
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get deployment info
description: Fetch information about a deployment.
operationId: pages-deployment-get-deployment-info
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get deployment info response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-response-details'
4XX:
description: Get deployment info response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-response-details'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs:
get:
tags:
- Accounts
summary: Cloudflare Get deployment logs
description: Fetch deployment logs for a project.
operationId: pages-deployment-get-deployment-logs
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get deployment logs response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-response-logs'
4XX:
description: Get deployment logs response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-response-logs'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry:
post:
tags:
- Accounts
summary: Cloudflare Retry deployment
description: Retry a previous deployment.
operationId: pages-deployment-retry-deployment
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Retry deployment response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-new-deployment'
4XX:
description: Retry deployment response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-new-deployment'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback:
post:
tags:
- Accounts
summary: Cloudflare Rollback deployment
description: Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.
operationId: pages-deployment-rollback-deployment
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Rollback deployment response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_deployment-response-details'
4XX:
description: Rollback deployment response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_deployment-response-details'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/domains:
get:
tags:
- Accounts
summary: Cloudflare Get domains
description: Fetch a list of all domains associated with a Pages project.
operationId: pages-domains-get-domains
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get domains response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_domain-response-collection'
4XX:
description: Get domains response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_domain-response-collection'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add domain
description: Add a new domain for the Pages project.
operationId: pages-domains-add-domain
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/pages_domains-post'
responses:
'200':
description: Add domain response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_domain-response-single'
4XX:
description: Add domain response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_domain-response-single'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete domain
description: Delete a Pages project's domain.
operationId: pages-domains-delete-domain
parameters:
- name: domain_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_domain_name'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete domain response.
content:
application/json:
schema:
example:
errors: []
messages: []
result: null
success: true
4xx:
description: Delete domain response failure.
content:
application/json:
schema:
allOf:
- example:
errors: []
messages: []
result: null
success: true
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get domain
description: Fetch a single domain.
operationId: pages-domains-get-domain
parameters:
- name: domain_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_domain_name'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Get domain response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_domain-response-single'
4XX:
description: Get domain response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_domain-response-single'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch domain
description: Retry the validation status of a single domain.
operationId: pages-domains-patch-domain
parameters:
- name: domain_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_domain_name'
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Patch domain response.
content:
application/json:
schema:
$ref: '#/components/schemas/pages_domain-response-single'
4XX:
description: Patch domain response failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_domain-response-single'
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache:
post:
tags:
- Accounts
summary: Cloudflare Purge build cache
description: Purge all cached build artifacts for a Pages project
operationId: pages-purge-build-cache
parameters:
- name: project_name
in: path
required: true
schema:
$ref: '#/components/schemas/pages_project_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/pages_identifier'
responses:
'200':
description: Purge build cache response.
content:
application/json:
schema:
example:
errors: []
messages: []
result: null
success: true
4XX:
description: Purge build cache failure.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/pages_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps:
get:
tags:
- Accounts
summary: Cloudflare List packet capture requests
description: Lists all packet capture requests for an account.
operationId: magic-pcap-collection-list-packet-capture-requests
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
responses:
'200':
description: List packet capture requests response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_collection_response'
default:
description: List packet capture requests response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_collection_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create PCAP request
description: Create new PCAP request for account.
operationId: magic-pcap-collection-create-pcap-request
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_request_pcap'
responses:
'200':
description: Create PCAP request response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_single_response'
default:
description: Create PCAP request response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps/{pcap_id}:
get:
tags:
- Accounts
summary: Cloudflare Get PCAP request
description: Get information for a PCAP request by id.
operationId: magic-pcap-collection-get-pcap-request
parameters:
- name: pcap_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
responses:
'200':
description: Get PCAP request response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_single_response'
default:
description: Get PCAP request response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps/{pcap_id}/download:
get:
tags:
- Accounts
summary: Cloudflare Download Simple PCAP
description: Download PCAP information into a file. Response is a binary PCAP file.
operationId: magic-pcap-collection-download-simple-pcap
parameters:
- name: pcap_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
responses:
'200':
description: Download Simple PCAP response
content:
application/vnd.tcpdump.pcap: {}
default:
description: Download Simple PCAP response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps/ownership:
get:
tags:
- Accounts
summary: Cloudflare List PCAPs Bucket Ownership
description: List all buckets configured for use with PCAPs API.
operationId: magic-pcap-collection-list-pca-ps-bucket-ownership
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
responses:
'200':
description: List PCAPs Bucket Ownership response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection'
default:
description: List PCAPs Bucket Ownership response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_ownership_collection'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add buckets for full packet captures
description: Adds an AWS or GCP bucket to use with full packet captures.
operationId: magic-pcap-collection-add-buckets-for-full-packet-captures
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_request'
responses:
'200':
description: Add buckets for full packet captures response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
default:
description: Add buckets for full packet captures response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps/ownership/{ownership_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete buckets for full packet captures
description: Deletes buckets added to the packet captures API.
operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures
parameters:
- name: ownership_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
responses:
'204':
description: Delete buckets for full packet captures response
default:
description: Delete buckets for full packet captures response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
/accounts/{account_id}/pcaps/ownership/validate:
post:
tags:
- Accounts
summary: Cloudflare Validate buckets for full packet captures
description: Validates buckets added to the packet captures API.
operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_validate_request'
responses:
'200':
description: Validate buckets for full packet captures response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
default:
description: Validate buckets for full packet captures response failure
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_ownership_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/r2/buckets:
get:
tags:
- Accounts
summary: Cloudflare List Buckets
description: Lists all R2 buckets on your account
operationId: r2-list-buckets
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
- name: name_contains
in: query
schema:
type: string
description: Bucket names to filter by. Only buckets with this phrase in their name will be returned.
example: my-bucket
- name: start_after
in: query
schema:
type: string
description: Bucket name to start searching after. Buckets are ordered lexicographically.
example: my-bucket
- name: per_page
in: query
schema:
type: number
description: Maximum number of buckets to return in a single call
default: 20
minimum: 1
maximum: 1000
- name: order
in: query
schema:
type: string
description: Field to order buckets by
enum:
- name
- name: direction
in: query
schema:
type: string
description: Direction to order buckets
enum:
- asc
- desc
example: desc
- name: cursor
in: query
schema:
type: string
description: Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.
responses:
'200':
description: List Buckets response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response_list'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/r2_bucket'
4XX:
description: List Buckets response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create Bucket
description: Creates a new R2 bucket.
operationId: r2-create-bucket
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
example: '{"name": "example-bucket"}'
required:
- name
properties:
locationHint:
$ref: '#/components/schemas/r2_bucket_location'
name:
$ref: '#/components/schemas/r2_bucket_name'
responses:
'200':
description: Create Bucket response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result:
$ref: '#/components/schemas/r2_bucket'
4XX:
description: Create Bucket response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
/accounts/{account_id}/r2/buckets/{bucket_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Bucket
description: Deletes an existing R2 bucket.
operationId: r2-delete-bucket
parameters:
- name: bucket_name
in: path
required: true
schema:
$ref: '#/components/schemas/r2_bucket_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
responses:
'200':
description: Delete Bucket response
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response'
4XX:
description: Delete Bucket response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
get:
tags:
- Accounts
summary: Cloudflare Get Bucket
description: Gets metadata for an existing R2 bucket.
operationId: r2-get-bucket
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
- name: bucket_name
in: path
required: true
schema:
$ref: '#/components/schemas/r2_bucket_name'
responses:
'200':
description: Get Bucket response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result:
$ref: '#/components/schemas/r2_bucket'
4XX:
description: Get Bucket response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
/accounts/{account_id}/r2/buckets/{bucket_name}/sippy:
delete:
tags:
- Accounts
summary: Cloudflare Disable Sippy
description: Disables Sippy on this bucket
operationId: r2-delete-bucket-sippy-config
parameters:
- name: bucket_name
in: path
required: true
schema:
$ref: '#/components/schemas/r2_bucket_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
responses:
'200':
description: Delete Sippy Configuration response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result:
type: object
properties:
enabled:
type: boolean
enum:
- false
4XX:
description: Delete Sippy Configuration response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
get:
tags:
- Accounts
summary: Cloudflare Get Sippy Configuration
description: Gets configuration for Sippy for an existing R2 bucket.
operationId: r2-get-bucket-sippy-config
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
- name: bucket_name
in: path
required: true
schema:
$ref: '#/components/schemas/r2_bucket_name'
responses:
'200':
description: Get Sippy Configuration response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result:
$ref: '#/components/schemas/r2_sippy'
4XX:
description: Get Sippy Configuration response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
put:
tags:
- Accounts
summary: Cloudflare Enable Sippy
description: Sets configuration for Sippy for an existing R2 bucket.
operationId: r2-put-bucket-sippy-config
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/r2_account_identifier'
- name: bucket_name
in: path
required: true
schema:
$ref: '#/components/schemas/r2_bucket_name'
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/r2_enable_sippy_aws'
- $ref: '#/components/schemas/r2_enable_sippy_gcs'
responses:
'200':
description: Set Sippy Configuration response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result:
$ref: '#/components/schemas/r2_sippy'
4XX:
description: Get Sippy Configuration response failure
content:
application/json:
schema:
$ref: '#/components/schemas/r2_v4_response_failure'
security:
- api_token: []
/accounts/{account_id}/registrar/domains:
get:
tags:
- Accounts
summary: Cloudflare List domains
description: List domains handled by Registrar.
operationId: registrar-domains-list-domains
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/registrar-api_identifier'
responses:
'200':
description: List domains response
content:
application/json:
schema:
$ref: '#/components/schemas/registrar-api_domain_response_collection'
4XX:
description: List domains response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/registrar-api_domain_response_collection'
- $ref: '#/components/schemas/registrar-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/registrar/domains/{domain_name}:
get:
tags:
- Accounts
summary: Cloudflare Get domain
description: Show individual domain.
operationId: registrar-domains-get-domain
parameters:
- name: domain_name
in: path
required: true
schema:
$ref: '#/components/schemas/registrar-api_domain_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/registrar-api_identifier'
responses:
'200':
description: Get domain response
content:
application/json:
schema:
$ref: '#/components/schemas/registrar-api_domain_response_single'
4XX:
description: Get domain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/registrar-api_domain_response_single'
- $ref: '#/components/schemas/registrar-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update domain
description: Update individual domain.
operationId: registrar-domains-update-domain
parameters:
- name: domain_name
in: path
required: true
schema:
$ref: '#/components/schemas/registrar-api_domain_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/registrar-api_identifier'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/registrar-api_domain_update_properties'
responses:
'200':
description: Update domain response
content:
application/json:
schema:
$ref: '#/components/schemas/registrar-api_domain_response_single'
4XX:
description: Update domain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/registrar-api_domain_response_single'
- $ref: '#/components/schemas/registrar-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/roles:
get:
tags:
- Accounts
summary: Cloudflare List Roles
description: Get all available roles for an account.
operationId: account-roles-list-roles
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
responses:
'200':
description: List Roles response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_collection_role_response'
4XX:
description: List Roles response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_collection'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/roles/{role_id}:
get:
tags:
- Accounts
summary: Cloudflare Role Details
description: Get information about a specific role for an account.
operationId: account-roles-role-details
parameters:
- name: role_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/iam_account_identifier'
responses:
'200':
description: Role Details response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_single_role_response'
4XX:
description: Role Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_single'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/rules/lists:
get:
tags:
- Accounts
summary: Cloudflare Get lists
description: Fetches all lists in the account.
operationId: lists-get-lists
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
responses:
'200':
description: Get lists response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_lists-response-collection'
4XX:
description: Get lists response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_lists-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a list
description: Creates a new list of the specified type.
operationId: lists-create-a-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- kind
properties:
description:
$ref: '#/components/schemas/lists_description'
kind:
$ref: '#/components/schemas/lists_kind'
name:
$ref: '#/components/schemas/lists_name'
responses:
'200':
description: Create a list response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_list-response-collection'
4XX:
description: Create a list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_list-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/rules/lists/{list_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a list
description: Deletes a specific list and all its items.
operationId: lists-delete-a-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a list response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_list-delete-response-collection'
4XX:
description: Delete a list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_list-delete-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a list
description: Fetches the details of a list.
operationId: lists-get-a-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
responses:
'200':
description: Get a list response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_list-response-collection'
4XX:
description: Get a list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_list-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a list
description: Updates the description of a list.
operationId: lists-update-a-list
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
$ref: '#/components/schemas/lists_description'
responses:
'200':
description: Update a list response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_list-response-collection'
4XX:
description: Update a list response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_list-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/rules/lists/{list_id}/items:
delete:
tags:
- Accounts
summary: Cloudflare Delete list items
description: 'Removes one or more items from a list.
This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.'
operationId: lists-delete-list-items
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
items:
type: array
minItems: 1
items:
properties:
id:
$ref: '#/components/schemas/lists_item_id'
responses:
'200':
description: Delete list items response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_lists-async-response'
4XX:
description: Delete list items response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_lists-async-response'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get list items
description: Fetches all the items in the list.
operationId: lists-get-list-items
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
- name: cursor
in: query
schema:
type: string
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
- name: per_page
in: query
schema:
type: integer
description: Amount of results to include in each paginated response. A non-negative 32 bit integer.
minimum: 1
maximum: 500
- name: search
in: query
schema:
type: string
description: 'A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.'
example: 1.1.1.
responses:
'200':
description: Get list items response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_items-list-response-collection'
4XX:
description: Get list items response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_items-list-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create list items
description: 'Appends new items to the list.
This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.'
operationId: lists-create-list-items
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/lists_items-update-request-collection'
responses:
'200':
description: Create list items response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_lists-async-response'
4XX:
description: Create list items response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_lists-async-response'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update all list items
description: 'Removes all existing items from the list and adds the provided items to the list.
This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.'
operationId: lists-update-all-list-items
parameters:
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/lists_items-update-request-collection'
responses:
'200':
description: Update all list items response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_lists-async-response'
4XX:
description: Update all list items response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_lists-async-response'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/rulesets:
get:
tags:
- Accounts
summary: Cloudflare List account rulesets
description: Fetches all rulesets at the account level.
operationId: listAccountRulesets
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: List account rulesets response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetsResponse'
4XX:
description: List account rulesets failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create an account ruleset
description: Creates a ruleset at the account level.
operationId: createAccountRuleset
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_CreateRulesetRequest'
responses:
'200':
description: Create an account ruleset response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Create an account ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an account ruleset
description: Deletes all versions of an existing account ruleset.
operationId: deleteAccountRuleset
parameters:
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'204':
description: Delete an account ruleset response
4XX:
description: Delete an account ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an account ruleset
description: Fetches the latest version of an account ruleset.
operationId: getAccountRuleset
parameters:
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: Get an account ruleset response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Get an account ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an account ruleset
description: Updates an account ruleset, creating a new version.
operationId: updateAccountRuleset
parameters:
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_UpdateRulesetRequest'
responses:
'200':
description: Update an account ruleset response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Update an account ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}/rules:
post:
tags:
- Accounts
summary: Cloudflare Create an account ruleset rule
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 by default.
operationId: createAccountRulesetRule
parameters:
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_CreateOrUpdateRuleRequest'
responses:
'200':
description: Create an account ruleset rule response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Create an account ruleset rule failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an account ruleset rule
description: Deletes an existing rule from an account ruleset.
operationId: deleteAccountRulesetRule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RuleId'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: Delete an account ruleset rule response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Delete an account ruleset rule failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update an account ruleset rule
description: Updates an existing rule in an account ruleset.
operationId: updateAccountRulesetRule
parameters:
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RuleId'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_CreateOrUpdateRuleRequest'
responses:
'200':
description: Update an account ruleset rule response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Update an account ruleset rule failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}/versions:
get:
tags:
- Accounts
summary: Cloudflare List an account ruleset's versions
description: Fetches the versions of an account ruleset.
operationId: listAccountRulesetVersions
parameters:
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: List an account ruleset's versions response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetsResponse'
4XX:
description: List an account ruleset's versions failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an account ruleset version
description: Deletes an existing version of an account ruleset.
operationId: deleteAccountRulesetVersion
parameters:
- name: ruleset_version
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetVersion'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'204':
description: Delete an account ruleset version response.
4XX:
description: Delete an account ruleset version failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an account ruleset version
description: Fetches a specific version of an account ruleset.
operationId: getAccountRulesetVersion
parameters:
- name: ruleset_version
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetVersion'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: Get an account ruleset version response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Get an account ruleset version failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}:
get:
tags:
- Accounts
summary: Cloudflare List an account ruleset version's rules by tag
description: Fetches the rules of a managed account ruleset version for a given tag.
operationId: listAccountRulesetVersionRulesByTag
parameters:
- name: rule_tag
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RuleCategory'
- name: ruleset_version
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetVersion'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetId'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: List an account ruleset version's rules by tag response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: List an account ruleset version's rules by tag failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint:
get:
tags:
- Accounts
summary: Cloudflare Get an account entry point ruleset
description: Fetches the latest version of the account entry point ruleset for a given phase.
operationId: getAccountEntrypointRuleset
parameters:
- name: ruleset_phase
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetPhase'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: Get an account entry point ruleset response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Get an account entry point ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an account entry point ruleset
description: Updates an account entry point ruleset, creating a new version.
operationId: updateAccountEntrypointRuleset
parameters:
- name: ruleset_phase
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetPhase'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_UpdateRulesetRequest'
responses:
'200':
description: Update an account entry point ruleset response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Update an account entry point ruleset failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
get:
tags:
- Accounts
summary: Cloudflare List an account entry point ruleset's versions
description: Fetches the versions of an account entry point ruleset.
operationId: listAccountEntrypointRulesetVersions
parameters:
- name: ruleset_phase
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetPhase'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: List an account entry point ruleset's versions response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetsResponse'
4XX:
description: List an account entry point ruleset's versions failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
get:
tags:
- Accounts
summary: Cloudflare Get an account entry point ruleset version
description: Fetches a specific version of an account entry point ruleset.
operationId: getAccountEntrypointRulesetVersion
parameters:
- name: ruleset_version
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetVersion'
- name: ruleset_phase
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_RulesetPhase'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rulesets_AccountId'
responses:
'200':
description: Get an account entry point ruleset version response.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/rulesets_Response'
- properties:
result:
$ref: '#/components/schemas/rulesets_RulesetResponse'
4XX:
description: Get an account entry point ruleset version failure response.
content:
application/json:
schema:
$ref: '#/components/schemas/rulesets_FailureResponse'
security:
- api_token: []
- api_email: []
api_key: []
- api_email: []
api_key: []
/accounts/{account_id}/rum/site_info:
post:
tags:
- Accounts
summary: Cloudflare Create a Web Analytics site
description: Creates a new Web Analytics site.
operationId: web-analytics-create-site
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rum_create-site-request'
responses:
'200':
description: Created Web Analytics site
content:
application/json:
schema:
$ref: '#/components/schemas/rum_site-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/rum/site_info/{site_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Web Analytics site
description: Deletes an existing Web Analytics site.
operationId: web-analytics-delete-site
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: site_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
responses:
'200':
description: Deleted Web Analytics site identifier
content:
application/json:
schema:
$ref: '#/components/schemas/rum_site-tag-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Get a Web Analytics site
description: Retrieves a Web Analytics site.
operationId: web-analytics-get-site
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: site_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
responses:
'200':
description: Web Analytics site
content:
application/json:
schema:
$ref: '#/components/schemas/rum_site-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update a Web Analytics site
description: Updates an existing Web Analytics site.
operationId: web-analytics-update-site
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: site_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rum_create-site-request'
responses:
'200':
description: Updated Web Analytics site
content:
application/json:
schema:
$ref: '#/components/schemas/rum_site-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/rum/site_info/list:
get:
tags:
- Accounts
summary: Cloudflare List Web Analytics sites
description: Lists all Web Analytics sites of an account.
operationId: web-analytics-list-sites
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: per_page
in: query
schema:
$ref: '#/components/schemas/rum_per_page'
- name: page
in: query
schema:
$ref: '#/components/schemas/rum_page'
- name: order_by
in: query
schema:
$ref: '#/components/schemas/rum_order_by'
responses:
'200':
description: List of Web Analytics sites
content:
application/json:
schema:
$ref: '#/components/schemas/rum_sites-response-collection'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/rum/v2/{ruleset_id}/rule:
post:
tags:
- Accounts
summary: Cloudflare Create a Web Analytics rule
description: Creates a new rule in a Web Analytics ruleset.
operationId: web-analytics-create-rule
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_ruleset_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rum_create-rule-request'
responses:
'200':
description: Created Web Analytics rule
content:
application/json:
schema:
$ref: '#/components/schemas/rum_rule-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Web Analytics rule
description: Deletes an existing rule from a Web Analytics ruleset.
operationId: web-analytics-delete-rule
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_ruleset_identifier'
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_rule_identifier'
responses:
'200':
description: Deleted Web Analytics rule identifier
content:
application/json:
schema:
$ref: '#/components/schemas/rum_rule-id-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update a Web Analytics rule
description: Updates a rule in a Web Analytics ruleset.
operationId: web-analytics-update-rule
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_ruleset_identifier'
- name: rule_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_rule_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rum_create-rule-request'
responses:
'200':
description: Updated Web Analytics rule
content:
application/json:
schema:
$ref: '#/components/schemas/rum_rule-response-single'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/rum/v2/{ruleset_id}/rules:
get:
tags:
- Accounts
summary: Cloudflare List rules in Web Analytics ruleset
description: Lists all the rules in a Web Analytics ruleset.
operationId: web-analytics-list-rules
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_ruleset_identifier'
responses:
'200':
description: List of Web Analytics rules in the ruleset
content:
application/json:
schema:
$ref: '#/components/schemas/rum_rules-response-collection'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Update Web Analytics rules
description: Modifies one or more rules in a Web Analytics ruleset with a single request.
operationId: web-analytics-modify-rules
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_identifier'
- name: ruleset_id
in: path
required: true
schema:
$ref: '#/components/schemas/rum_ruleset_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/rum_modify-rules-request'
responses:
'200':
description: List of modified Web Analytics rules
content:
application/json:
schema:
$ref: '#/components/schemas/rum_rules-response-collection'
4XX:
description: Failure response
content:
application/json:
schema:
$ref: '#/components/schemas/rum_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/secondary_dns/acls:
get:
tags:
- Accounts
summary: Cloudflare List ACLs
description: List ACLs.
operationId: secondary-dns-(-acl)-list-ac-ls
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: List ACLs response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
4XX:
description: List ACLs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create ACL
description: Create ACL.
operationId: secondary-dns-(-acl)-create-acl
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- ip_range
responses:
'200':
description: Create ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
4XX:
description: Create ACL response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/secondary_dns/acls/{acl_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete ACL
description: Delete ACL.
operationId: secondary-dns-(-acl)-delete-acl
parameters:
- name: acl_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
4XX:
description: Delete ACL response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare ACL Details
description: Get ACL.
operationId: secondary-dns-(-acl)-acl-details
parameters:
- name: acl_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: ACL Details response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
4XX:
description: ACL Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update ACL
description: Modify ACL.
operationId: secondary-dns-(-acl)-update-acl
parameters:
- name: acl_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_acl'
responses:
'200':
description: Update ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
4XX:
description: Update ACL response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/secondary_dns/peers:
get:
tags:
- Accounts
summary: Cloudflare List Peers
description: List Peers.
operationId: secondary-dns-(-peer)-list-peers
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: List Peers response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_schemas-response_collection'
4XX:
description: List Peers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_schemas-response_collection'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Peer
description: Create Peer.
operationId: secondary-dns-(-peer)-create-peer
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
responses:
'200':
description: Create Peer response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_schemas-single_response'
4XX:
description: Create Peer response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/secondary_dns/peers/{peer_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Peer
description: Delete Peer.
operationId: secondary-dns-(-peer)-delete-peer
parameters:
- name: peer_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Peer response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
4XX:
description: Delete Peer response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Peer Details
description: Get Peer.
operationId: secondary-dns-(-peer)-peer-details
parameters:
- name: peer_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: Peer Details response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_schemas-single_response'
4XX:
description: Peer Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Peer
description: Modify Peer.
operationId: secondary-dns-(-peer)-update-peer
parameters:
- name: peer_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_peer'
responses:
'200':
description: Update Peer response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_schemas-single_response'
4XX:
description: Update Peer response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_schemas-single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/secondary_dns/tsigs:
get:
tags:
- Accounts
summary: Cloudflare List TSIGs
description: List TSIGs.
operationId: secondary-dns-(-tsig)-list-tsi-gs
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: List TSIGs response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_response_collection'
4XX:
description: List TSIGs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_response_collection'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create TSIG
description: Create TSIG.
operationId: secondary-dns-(-tsig)-create-tsig
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_tsig'
responses:
'200':
description: Create TSIG response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_single_response'
4XX:
description: Create TSIG response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete TSIG
description: Delete TSIG.
operationId: secondary-dns-(-tsig)-delete-tsig
parameters:
- name: tsig_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete TSIG response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_schemas-id_response'
4XX:
description: Delete TSIG response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_schemas-id_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare TSIG Details
description: Get TSIG.
operationId: secondary-dns-(-tsig)-tsig-details
parameters:
- name: tsig_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
responses:
'200':
description: TSIG Details response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_single_response'
4XX:
description: TSIG Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update TSIG
description: Modify TSIG.
operationId: secondary-dns-(-tsig)-update-tsig
parameters:
- name: tsig_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/secondary-dns_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_tsig'
responses:
'200':
description: Update TSIG response
content:
application/json:
schema:
$ref: '#/components/schemas/secondary-dns_single_response'
4XX:
description: Update TSIG response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/secondary-dns_single_response'
- $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/storage/analytics:
get:
tags:
- Accounts
summary: Cloudflare Query Request Analytics
description: Retrieves Workers KV request metrics for the given account.
operationId: workers-kv-request-analytics-query-request-analytics
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
- name: query
in: query
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_query'
- 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':
description: Query Request Analytics response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_schemas-result'
4XX:
description: Query Request Analytics response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_result'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/analytics/stored:
get:
tags:
- Accounts
summary: Cloudflare Query Stored Data Analytics
description: Retrieves Workers KV stored data metrics for the given account.
operationId: workers-kv-stored-data-analytics-query-stored-data-analytics
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
- name: query
in: query
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_query'
- 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':
description: Query Stored Data Analytics response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_components-schemas-result'
4XX:
description: Query Stored Data Analytics response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_result'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces:
get:
tags:
- Accounts
summary: Cloudflare List Namespaces
description: Returns the namespaces owned by an account.
operationId: workers-kv-namespace-list-namespaces
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results per page.
default: 20
minimum: 5
maximum: 100
- name: order
in: query
schema:
description: Field to order results by.
enum:
- id
- title
example: id
- name: direction
in: query
schema:
description: Direction to order namespaces.
enum:
- asc
- desc
example: asc
responses:
'200':
description: List Namespaces response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers-kv_namespace'
4XX:
description: List Namespaces response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers-kv_namespace'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Namespace
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_create_rename_namespace_body'
responses:
'200':
description: Create a Namespace response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_namespace'
4XX:
description: Create a Namespace response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/workers-kv_namespace'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}:
delete:
tags:
- Accounts
summary: Cloudflare Remove a Namespace
description: Deletes the namespace corresponding to the given ID.
operationId: workers-kv-namespace-remove-a-namespace
parameters:
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Remove a Namespace response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Remove a Namespace response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Rename a Namespace
description: Modifies a namespace's title.
operationId: workers-kv-namespace-rename-a-namespace
parameters:
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_create_rename_namespace_body'
responses:
'200':
description: Rename a Namespace response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Rename a Namespace response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk:
delete:
tags:
- Accounts
summary: Cloudflare Delete multiple key-value pairs
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:
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_bulk_delete'
responses:
'200':
description: Delete multiple key-value pairs response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Delete multiple key-value pairs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Write multiple key-value pairs
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:
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_bulk_write'
responses:
'200':
description: Write multiple key-value pairs response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Write multiple key-value pairs response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys:
get:
tags:
- Accounts
summary: Cloudflare List a Namespace's Keys
description: Lists a namespace's keys.
operationId: workers-kv-namespace-list-a-namespace'-s-keys
parameters:
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
- name: limit
in: query
schema:
type: number
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.
default: 1000
minimum: 10
maximum: 1000
- name: prefix
in: query
schema:
type: string
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
- name: cursor
in: query
schema:
type: string
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
responses:
'200':
description: List a Namespace's Keys response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/workers-kv_key'
result_info:
properties:
count:
type: number
description: Total results returned based on your list parameters.
example: 1
cursor:
$ref: '#/components/schemas/workers-kv_cursor'
4XX:
description: List a Namespace's Keys response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/workers-kv_key'
result_info:
properties:
count:
type: number
description: Total results returned based on your list parameters.
example: 1
cursor:
$ref: '#/components/schemas/workers-kv_cursor'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}:
get:
tags:
- Accounts
summary: Cloudflare Read the metadata for a key
description: Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.
operationId: workers-kv-namespace-read-the-metadata-for-a-key
parameters:
- name: key_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_key_name'
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
responses:
'200':
description: Read the metadata for a key response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- properties:
result:
$ref: '#/components/schemas/workers-kv_list_metadata'
4XX:
description: Read the metadata for a key response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- properties:
result:
$ref: '#/components/schemas/workers-kv_list_metadata'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete key-value pair
description: Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.
operationId: workers-kv-namespace-delete-key-value-pair
parameters:
- name: key_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_key_name'
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete key-value pair response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Delete key-value pair response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Read key-value pair
description: Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header.
operationId: workers-kv-namespace-read-key-value-pair
parameters:
- name: key_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_key_name'
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
responses:
'200':
description: Read key-value pair response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_value'
4XX:
description: Read key-value pair response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_value'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Write key-value pair with metadata
description: Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored along with JSON metadata to be associated with the key/value pair. Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.
operationId: workers-kv-namespace-write-key-value-pair-with-metadata
parameters:
- name: key_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_key_name'
- name: namespace_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers-kv_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- value
- metadata
properties:
metadata:
$ref: '#/components/schemas/workers-kv_metadata'
value:
$ref: '#/components/schemas/workers-kv_value'
responses:
'200':
description: Write key-value pair with metadata response
content:
application/json:
schema:
$ref: '#/components/schemas/workers-kv_api-response-single'
4XX:
description: Write key-value pair with metadata response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-single'
- $ref: '#/components/schemas/workers-kv_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/stream:
get:
tags:
- Accounts
summary: Cloudflare List videos
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: status
in: query
schema:
$ref: '#/components/schemas/stream_media_state'
- name: creator
in: query
schema:
$ref: '#/components/schemas/stream_creator'
- name: type
in: query
schema:
$ref: '#/components/schemas/stream_type'
- name: asc
in: query
schema:
$ref: '#/components/schemas/stream_asc'
- name: search
in: query
schema:
$ref: '#/components/schemas/stream_search'
- name: start
in: query
schema:
$ref: '#/components/schemas/stream_start'
- name: end
in: query
schema:
$ref: '#/components/schemas/stream_end'
- name: include_counts
in: query
schema:
$ref: '#/components/schemas/stream_include_counts'
responses:
'200':
description: List videos response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_response_collection'
4XX:
description: List videos response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Initiate video uploads using TUS
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:
- name: Tus-Resumable
in: header
required: true
schema:
$ref: '#/components/schemas/stream_tus_resumable'
- name: Upload-Creator
in: header
schema:
$ref: '#/components/schemas/stream_creator'
- name: Upload-Length
in: header
required: true
schema:
$ref: '#/components/schemas/stream_upload_length'
- name: Upload-Metadata
in: header
schema:
$ref: '#/components/schemas/stream_upload_metadata'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Initiate video uploads using TUS response
content:
application/json: {}
4XX:
description: Initiate video uploads using TUS response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete video
description: Deletes a video and its copies from Cloudflare Stream.
operationId: stream-videos-delete-video
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete video response
content:
application/json: {}
4XX:
description: Delete video response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Retrieve video details
description: Fetches details for a single video.
operationId: stream-videos-retrieve-video-details
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
responses:
'200':
description: Retrieve video details response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_response_single'
4XX:
description: Retrieve video details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Edit video details
description: Edit details for a single video.
operationId: stream-videos-update-video-details
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_update'
responses:
'200':
description: Edit video details response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_response_single'
4XX:
description: Edit video details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/audio:
get:
tags:
- Accounts
summary: Cloudflare List additional audio tracks on a video
description: Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.
operationId: list-audio-tracks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
responses:
'200':
description: Lists additional audio tracks on a video
content:
application/json:
schema:
$ref: '#/components/schemas/stream_listAudioTrackResponse'
4XX:
description: Lists additional audio tracks on a video response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete additional audio tracks on a video
description: Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.
operationId: delete-audio-tracks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: audio_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_audio_identifier'
responses:
'200':
description: Deletes additional audio tracks on a video
content:
application/json:
schema:
$ref: '#/components/schemas/stream_deleted_response'
4XX:
description: Deletes additional audio tracks on a video response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_deleted_response'
security:
- api_email: []
api_key: []
api_token: []
patch:
tags:
- Accounts
summary: Cloudflare Edit additional audio tracks on a video
description: Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`.
operationId: edit-audio-tracks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: audio_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_audio_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_editAudioTrack'
responses:
'200':
description: Edits additional audio tracks on a video
content:
application/json:
schema:
$ref: '#/components/schemas/stream_addAudioTrackResponse'
4XX:
description: Edits additional audio tracks on a video response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/audio/copy:
post:
tags:
- Accounts
summary: Cloudflare Add audio tracks to a video
description: Adds an additional audio track to a video using the provided audio track URL.
operationId: add-audio-track
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_copyAudioTrack'
responses:
'200':
description: Add audio tracks to a video
content:
application/json:
schema:
$ref: '#/components/schemas/stream_addAudioTrackResponse'
4XX:
description: Add audio tracks to a video response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/captions:
get:
tags:
- Accounts
summary: Cloudflare List captions or subtitles
description: Lists the available captions or subtitles for a specific video.
operationId: stream-subtitles/-captions-list-captions-or-subtitles
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: List captions or subtitles response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_language_response_collection'
4XX:
description: List captions or subtitles response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/captions/{language}:
delete:
tags:
- Accounts
summary: Cloudflare Delete captions or subtitles
description: Removes the captions or subtitles from a video.
operationId: stream-subtitles/-captions-delete-captions-or-subtitles
parameters:
- name: language
in: path
required: true
schema:
$ref: '#/components/schemas/stream_language'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete captions or subtitles response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: string
example: ''
4XX:
description: Delete captions or subtitles response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Upload captions or subtitles
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:
- name: language
in: path
required: true
schema:
$ref: '#/components/schemas/stream_language'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/stream_caption_basic_upload'
responses:
'200':
description: Upload captions or subtitles response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_language_response_single'
4XX:
description: Upload captions or subtitles response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/downloads:
delete:
tags:
- Accounts
summary: Cloudflare Delete downloads
description: Delete the downloads for a video.
operationId: stream-m-p-4-downloads-delete-downloads
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: Delete downloads response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_deleted_response'
4XX:
description: Delete downloads response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare List downloads
description: Lists the downloads created for a video.
operationId: stream-m-p-4-downloads-list-downloads
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: List downloads response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_downloads_response'
4XX:
description: List downloads response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create downloads
description: Creates a download for a video when a video is ready to view.
operationId: stream-m-p-4-downloads-create-downloads
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Create downloads response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_downloads_response'
4XX:
description: Create downloads response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/embed:
get:
tags:
- Accounts
summary: Cloudflare Retrieve embed Code HTML
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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
responses:
'200':
description: Retreieve embed Code HTML response
content:
application/json:
schema:
example:
4XX:
description: Retreieve embed Code HTML response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/{identifier}/token:
post:
tags:
- Accounts
summary: Cloudflare Create signed URL tokens for videos
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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_signed_token_request'
responses:
'200':
description: Create signed URL tokens for videos response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_signed_token_response'
4XX:
description: Create signed URL tokens for videos response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/clip:
post:
tags:
- Accounts
summary: Cloudflare Clip videos given a start and end time
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_videoClipStandard'
responses:
'200':
description: Clip videos given a start and end time response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_clipResponseSingle'
4XX:
description: Clip videos given a start and end time response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/copy:
post:
tags:
- Accounts
summary: Cloudflare Upload videos from a URL
description: Uploads a video to Stream from a provided URL.
operationId: stream-videos-upload-videos-from-a-url
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: Upload-Creator
in: header
schema:
$ref: '#/components/schemas/stream_creator'
- name: Upload-Metadata
in: header
schema:
$ref: '#/components/schemas/stream_upload_metadata'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_copy_request'
responses:
'200':
description: Upload videos from a URL response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_video_response_single'
4XX:
description: Upload videos from a URL response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/direct_upload:
post:
tags:
- Accounts
summary: Cloudflare Upload videos via direct upload URLs
description: Creates a direct upload that allows video uploads without an API key.
operationId: stream-videos-upload-videos-via-direct-upload-ur-ls
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: Upload-Creator
in: header
schema:
$ref: '#/components/schemas/stream_creator'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_direct_upload_request'
responses:
'200':
description: Upload videos via direct upload URLs response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_direct_upload_response'
4XX:
description: Upload videos via direct upload URLs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/keys:
get:
tags:
- Accounts
summary: Cloudflare List signing keys
description: Lists the video ID and creation date and time when a signing key was created.
operationId: stream-signing-keys-list-signing-keys
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: List signing keys response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_key_response_collection'
4XX:
description: List signing keys response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create signing keys
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Create signing keys response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_key_generation_response'
4XX:
description: Create signing keys response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/keys/{identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete signing keys
description: Deletes signing keys and revokes all signed URLs generated with the key.
operationId: stream-signing-keys-delete-signing-keys
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete signing keys response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_deleted_response'
4XX:
description: Delete signing keys response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/live_inputs:
get:
tags:
- Accounts
summary: Cloudflare List live inputs
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
- name: include_counts
in: query
schema:
$ref: '#/components/schemas/stream_include_counts'
responses:
'200':
description: List live inputs response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_live_input_response_collection'
4XX:
description: List live inputs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create a live input
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:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_create_input_request'
responses:
'200':
description: Create a live input response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_live_input_response_single'
4XX:
description: Create a live input response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a live input
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:
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a live input response
content:
application/json: {}
4XX:
description: Delete a live input response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Retrieve a live input
description: Retrieves details of an existing live input.
operationId: stream-live-inputs-retrieve-a-live-input
parameters:
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: Retrieve a live input response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_live_input_response_single'
4XX:
description: Retrieve a live input response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update a live input
description: Updates a specified live input.
operationId: stream-live-inputs-update-a-live-input
parameters:
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_update_input_request'
responses:
'200':
description: Update a live input response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_live_input_response_single'
4XX:
description: Update a live input response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs:
get:
tags:
- Accounts
summary: Cloudflare List all outputs associated with a specified live input
description: Retrieves all outputs associated with a specified live input.
operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input
parameters:
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
responses:
'200':
description: List all outputs associated with a specified live input response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_output_response_collection'
4XX:
description: List all outputs associated with a specified live input response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create a new output, connected to a live input
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:
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_create_output_request'
responses:
'200':
description: Create a new output, connected to a live input response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_output_response_single'
4XX:
description: Create a new output, connected to a live input response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an output
description: Deletes an output and removes it from the associated live input.
operationId: stream-live-inputs-delete-an-output
parameters:
- name: output_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_output_identifier'
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete an output response
content:
application/json: {}
4XX:
description: Delete an output response failure
content:
application/json: {}
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update an output
description: Updates the state of an output.
operationId: stream-live-inputs-update-an-output
parameters:
- name: output_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_output_identifier'
- name: live_input_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_live_input_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_schemas-identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_update_output_request'
responses:
'200':
description: Update an output response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_output_response_single'
4XX:
description: Update an output response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/storage-usage:
get:
tags:
- Accounts
summary: Cloudflare Storage use
description: Returns information about an account's storage use.
operationId: stream-videos-storage-usage
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
- name: creator
in: query
schema:
$ref: '#/components/schemas/stream_creator'
responses:
'200':
description: Returns information about an account's storage use response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_storage_use_response'
4XX:
description: Returns information about an account's storage use response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/watermarks:
get:
tags:
- Accounts
summary: Cloudflare List watermark profiles
description: Lists all watermark profiles for an account.
operationId: stream-watermark-profile-list-watermark-profiles
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
responses:
'200':
description: List watermark profiles response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_watermark_response_collection'
4XX:
description: List watermark profiles response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create watermark profiles via basic upload
description: Creates watermark profiles using a single `HTTP POST multipart/form-data` request.
operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/stream_watermark_basic_upload'
responses:
'200':
description: Create watermark profiles via basic upload response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_watermark_response_single'
4XX:
description: Create watermark profiles via basic upload response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/watermarks/{identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete watermark profiles
description: Deletes a watermark profile.
operationId: stream-watermark-profile-delete-watermark-profiles
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_watermark_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete watermark profiles response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: string
example: ''
4XX:
description: Delete watermark profiles response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare Watermark profile details
description: Retrieves details for a single watermark profile.
operationId: stream-watermark-profile-watermark-profile-details
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/stream_watermark_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
responses:
'200':
description: Watermark profile details response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_watermark_response_single'
4XX:
description: Watermark profile details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/stream/webhook:
delete:
tags:
- Accounts
summary: Cloudflare Delete webhooks
description: Deletes a webhook.
operationId: stream-webhook-delete-webhooks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete webhooks response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_deleted_response'
4XX:
description: Delete webhooks response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
get:
tags:
- Accounts
summary: Cloudflare View webhooks
description: Retrieves a list of webhooks.
operationId: stream-webhook-view-webhooks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
responses:
'200':
description: View webhooks response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_webhook_response_single'
4XX:
description: View webhooks response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Create webhooks
description: Creates a webhook notification.
operationId: stream-webhook-create-webhooks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/stream_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/stream_webhook_request'
responses:
'200':
description: Create webhooks response
content:
application/json:
schema:
$ref: '#/components/schemas/stream_webhook_response_single'
4XX:
description: Create webhooks response failure
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_id}/teamnet/routes:
get:
tags:
- Accounts
summary: Cloudflare List tunnel routes
description: Lists and filters private network routes in an account.
operationId: tunnel-route-list-tunnel-routes
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: comment
in: query
schema:
$ref: '#/components/schemas/tunnel_comment'
- name: is_deleted
in: query
schema:
description: If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included.
- name: network_subset
in: query
schema:
description: If set, only list routes that are contained within this IP range.
- name: network_superset
in: query
schema:
description: If set, only list routes that contain this IP range.
- name: existed_at
in: query
schema:
description: If provided, include only routes that were created (and not deleted) before this time.
- name: tunnel_id
in: query
schema:
description: UUID of the Cloudflare Tunnel serving the route.
- name: route_id
in: query
schema:
$ref: '#/components/schemas/tunnel_route_id'
- name: tun_types
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_types'
- name: virtual_network_id
in: query
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.
- name: per_page
in: query
schema:
$ref: '#/components/schemas/tunnel_per_page'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
responses:
'200':
description: List tunnel routes response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_teamnet_response_collection'
4XX:
description: List tunnel routes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_teamnet_response_collection'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a tunnel route
description: Routes a private network through a Cloudflare Tunnel.
operationId: tunnel-route-create-a-tunnel-route
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ip_network
- tunnel_id
properties:
comment:
$ref: '#/components/schemas/tunnel_comment'
ip_network:
$ref: '#/components/schemas/tunnel_ip_network'
tunnel_id:
$ref: '#/components/schemas/tunnel_tunnel_id'
virtual_network_id:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
responses:
'200':
description: Create a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Create a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/teamnet/routes/{route_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a tunnel route
description: 'Deletes a private network route from an account.
'
operationId: tunnel-route-delete-a-tunnel-route
parameters:
- name: route_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_route_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Delete a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Delete a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a tunnel route
description: Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.
operationId: tunnel-route-update-a-tunnel-route
parameters:
- name: route_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_route_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
comment:
$ref: '#/components/schemas/tunnel_comment'
network:
$ref: '#/components/schemas/tunnel_ip_network'
tun_type:
$ref: '#/components/schemas/tunnel_tunnel_type'
tunnel_id:
$ref: '#/components/schemas/tunnel_route_tunnel_id'
virtual_network_id:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
responses:
'200':
description: Update a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Update a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/teamnet/routes/ip/{ip}:
get:
tags:
- Accounts
summary: Cloudflare Get tunnel route by IP
description: Fetches routes that contain the given IP address.
operationId: tunnel-route-get-tunnel-route-by-ip
parameters:
- name: ip
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_ip'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: virtual_network_id
in: query
schema:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
responses:
'200':
description: Get tunnel route by IP response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_teamnet_response_single'
4XX:
description: Get tunnel route by IP response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_teamnet_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a tunnel route (CIDR Endpoint)
description: 'Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.
'
operationId: tunnel-route-delete-a-tunnel-route-with-cidr
parameters:
- name: ip_network_encoded
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_ip_network_encoded'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: virtual_network_id
in: query
schema:
$ref: '#/components/schemas/tunnel_vnet_id'
- name: tun_type
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_type'
- name: tunnel_id
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
responses:
'200':
description: Delete a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Delete a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a tunnel route (CIDR Endpoint)
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-with-cidr
parameters:
- name: ip_network_encoded
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_ip_network_encoded'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Update a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Update a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a tunnel route (CIDR Endpoint)
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-with-cidr
parameters:
- name: ip_network_encoded
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_ip_network_encoded'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tunnel_id
properties:
comment:
$ref: '#/components/schemas/tunnel_comment'
tunnel_id:
$ref: '#/components/schemas/tunnel_tunnel_id'
virtual_network_id:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
responses:
'200':
description: Create a tunnel route response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_route_response_single'
4XX:
description: Create a tunnel route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_route_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{account_id}/teamnet/virtual_networks:
get:
tags:
- Accounts
summary: Cloudflare List virtual networks
description: Lists and filters virtual networks in an account.
operationId: tunnel-virtual-network-list-virtual-networks
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: name
in: query
schema:
$ref: '#/components/schemas/tunnel_vnet_name'
- name: is_default
in: query
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.
- name: is_deleted
in: query
schema:
description: If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included.
- name: vnet_name
in: query
schema:
$ref: '#/components/schemas/tunnel_vnet_name'
- name: vnet_id
in: query
schema:
type: string
description: UUID of the virtual network.
example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
responses:
'200':
description: List virtual networks response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_vnet_response_collection'
4XX:
description: List virtual networks response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_vnet_response_collection'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a virtual network
description: Adds a new virtual network to an account.
operationId: tunnel-virtual-network-create-a-virtual-network
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
comment:
$ref: '#/components/schemas/tunnel_schemas-comment'
is_default:
$ref: '#/components/schemas/tunnel_is_default_network'
name:
$ref: '#/components/schemas/tunnel_vnet_name'
responses:
'200':
description: Create a virtual network response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_vnet_response_single'
4XX:
description: Create a virtual network response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_vnet_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a virtual network
description: Deletes an existing virtual network.
operationId: tunnel-virtual-network-delete-a-virtual-network
parameters:
- name: virtual_network_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_vnet_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a virtual network response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_vnet_response_single'
4XX:
description: Delete a virtual network response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_vnet_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a virtual network
description: Updates an existing virtual network.
operationId: tunnel-virtual-network-update-a-virtual-network
parameters:
- name: virtual_network_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_vnet_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
comment:
$ref: '#/components/schemas/tunnel_schemas-comment'
is_default_network:
$ref: '#/components/schemas/tunnel_is_default_network'
name:
$ref: '#/components/schemas/tunnel_vnet_name'
responses:
'200':
description: Update a virtual network response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_vnet_response_single'
4XX:
description: Update a virtual network response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_vnet_response_single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/tunnels:
get:
tags:
- Accounts
summary: Cloudflare List All Tunnels
description: Lists and filters all types of Tunnels in an account.
operationId: cloudflare-tunnel-list-all-tunnels
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: name
in: query
schema:
type: string
description: A user-friendly name for the tunnel.
example: blog
- name: is_deleted
in: query
schema:
type: boolean
description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
example: true
- name: existed_at
in: query
schema:
$ref: '#/components/schemas/tunnel_existed_at'
- name: uuid
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: was_active_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: was_inactive_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: include_prefix
in: query
schema:
type: string
example: vpc1-
- name: exclude_prefix
in: query
schema:
type: string
example: vpc1-
- name: tun_types
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_types'
- name: per_page
in: query
schema:
$ref: '#/components/schemas/tunnel_per_page'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
responses:
'200':
description: List Tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-collection'
4XX:
description: List Tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-collection'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create an Argo Tunnel
description: Creates a new Argo Tunnel in an account.
operationId: argo-tunnel-create-an-argo-tunnel
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- tunnel_secret
properties:
name:
$ref: '#/components/schemas/tunnel_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.
responses:
'200':
description: Create an Argo Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
4XX:
description: Create an Argo Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{account_id}/tunnels/{tunnel_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an Argo Tunnel
description: Deletes an Argo Tunnel from an account.
operationId: argo-tunnel-delete-an-argo-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Delete an Argo Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
4XX:
description: Delete an Argo Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an Argo Tunnel
description: Fetches a single Argo Tunnel.
operationId: argo-tunnel-get-an-argo-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get an Argo Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
4XX:
description: Get an Argo Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_legacy-tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{account_id}/tunnels/{tunnel_id}/connections:
delete:
tags:
- Accounts
summary: Cloudflare Clean up Argo Tunnel connections
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:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Clean up Argo Tunnel connections response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_empty_response'
4XX:
description: Clean up Argo Tunnel connections response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_empty_response'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{account_id}/warp_connector:
get:
tags:
- Accounts
summary: Cloudflare List Warp Connector Tunnels
description: Lists and filters Warp Connector Tunnels in an account.
operationId: cloudflare-tunnel-list-warp-connector-tunnels
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
- name: name
in: query
schema:
type: string
description: A user-friendly name for the tunnel.
example: blog
- name: is_deleted
in: query
schema:
type: boolean
description: If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.
example: true
- name: existed_at
in: query
schema:
$ref: '#/components/schemas/tunnel_existed_at'
- name: uuid
in: query
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: was_active_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: was_inactive_at
in: query
schema:
type: string
format: date-time
example: '2009-11-10T23:00:00Z'
- name: include_prefix
in: query
schema:
type: string
example: vpc1-
- name: exclude_prefix
in: query
schema:
type: string
example: vpc1-
- name: per_page
in: query
schema:
$ref: '#/components/schemas/tunnel_per_page'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
responses:
'200':
description: List Warp Connector Tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-collection'
4XX:
description: List Warp Connector Tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-collection'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Warp Connector Tunnel
description: Creates a new Warp Connector Tunnel in an account.
operationId: cloudflare-tunnel-create-a-warp-connector-tunnel
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
responses:
'200':
description: Create a Warp Connector Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Create a Warp Connector Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/warp_connector/{tunnel_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Warp Connector Tunnel
description: Deletes a Warp Connector Tunnel from an account.
operationId: cloudflare-tunnel-delete-a-warp-connector-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Delete a Warp Connector Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Delete a Warp Connector Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Warp Connector Tunnel
description: Fetches a single Warp Connector Tunnel.
operationId: cloudflare-tunnel-get-a-warp-connector-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get a Warp Connector Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Get a Warp Connector Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update a Warp Connector Tunnel
description: Updates an existing Warp Connector Tunnel.
operationId: cloudflare-tunnel-update-a-warp-connector-tunnel
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
tunnel_secret:
$ref: '#/components/schemas/tunnel_tunnel_secret'
responses:
'200':
description: Update a Warp Connector Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel-response-single'
4XX:
description: Update a Warp Connector Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel-response-single'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/warp_connector/{tunnel_id}/token:
get:
tags:
- Accounts
summary: Cloudflare Get a Warp Connector Tunnel token
description: Gets the token used to associate warp device with a specific Warp Connector tunnel.
operationId: cloudflare-tunnel-get-a-warp-connector-tunnel-token
parameters:
- name: tunnel_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_tunnel_id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get a Warp Connector Tunnel token response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_tunnel_response_token'
4XX:
description: Get a Warp Connector Tunnel token response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/tunnel_tunnel_response_token'
- $ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_id}/workers/account-settings:
get:
tags:
- Accounts
summary: Cloudflare Fetch Worker Account Settings
description: Fetches Worker account settings for an account.
operationId: worker-account-settings-fetch-worker-account-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Fetch Worker Account Settings response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_account-settings-response'
4XX:
description: Fetch Worker Account Settings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_account-settings-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Create Worker Account Settings
description: Creates Worker account settings for an account.
operationId: worker-account-settings-create-worker-account-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example: '{''default_usage_model'': ''unbound''}'
responses:
'200':
description: Create Worker Account Settings response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_account-settings-response'
4XX:
description: Create Worker Account Settings response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_account-settings-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/deployments/by-script/{script_id}:
get:
tags:
- Accounts
summary: Cloudflare List Deployments
operationId: worker-deployments-list-deployments
parameters:
- name: script_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Deployments response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_deployments-list-response'
4XX:
description: List Deployments response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_deployments-list-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/deployments/by-script/{script_id}/detail/{deployment_id}:
get:
tags:
- Accounts
summary: Cloudflare Get Deployment Detail
operationId: worker-deployments-get-deployment-detail
parameters:
- name: deployment_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_deployment_identifier'
- name: script_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Get Deployment Detail response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_deployments-single-response'
4XX:
description: Get Deployment Detail response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_deployments-single-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces:
get:
tags:
- Accounts
summary: Cloudflare List dispatch namespaces
description: Fetch a list of Workers for Platforms namespaces.
operationId: namespace-worker-list
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Fetch a list of Workers for Platforms namespaces.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_namespace-list-response'
4XX:
description: Failure to get list of Workers for Platforms namespaces.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create dispatch namespace
description: Create a new Workers for Platforms namespace.
operationId: namespace-worker-create
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the dispatch namespace
example: my-dispatch-namespace
responses:
'200':
description: Fetch a list of Workers for Platforms namespaces.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_namespace-single-response'
4XX:
description: Failure to get list of Workers for Platforms namespaces.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}:
delete:
tags:
- Accounts
summary: Cloudflare Delete dispatch namespace
description: Delete a Workers for Platforms namespace.
operationId: namespace-worker-delete-namespace
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
responses:
'200':
description: Delete a Workers for Platforms namespace.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_namespace-delete-response'
4XX:
description: Failure to delete Workers for Platforms namespace.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Fetch dispatch namespace
description: Fetch a Workers for Platforms namespace.
operationId: namespace-worker-get-namespace
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
responses:
'200':
description: Fetch a Workers for Platforms namespace.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_namespace-single-response'
4XX:
description: Failure to get Workers for Platforms namespace.
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Worker (Workers for Platforms)
description: Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete.
operationId: namespace-worker-script-delete-worker
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: force
in: query
description: If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.
schema:
type: boolean
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Worker response
content:
application/json: {}
4XX:
description: Delete Worker response failure
content:
application/json: {}
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Worker Details (Workers for Platforms)
description: Fetch information about a script uploaded to a Workers for Platforms namespace.
operationId: namespace-worker-script-worker-details
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Worker Details Response (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_namespace-script-response-single'
4XX:
description: Worker Details Failure (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Upload Worker Module (Workers for Platforms)
description: Upload a worker module to a Workers for Platforms namespace.
operationId: namespace-worker-script-upload-worker-module
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
requestBody:
$ref: '#/components/requestBodies/workers_script_upload'
responses:
'200':
$ref: '#/components/responses/workers_200'
4XX:
$ref: '#/components/responses/workers_4XX'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings:
get:
tags:
- Accounts
summary: Cloudflare Get Script Bindings (Workers for Platforms)
description: Fetch script bindings from a script uploaded to a Workers for Platforms namespace.
operationId: namespace-worker-get-script-bindings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Fetch script bindings (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_binding'
4XX:
description: Fetch script bindings failure (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content:
get:
tags:
- Accounts
summary: Cloudflare Get Script Content (Workers for Platforms)
description: Fetch script content from a script uploaded to a Workers for Platforms namespace.
operationId: namespace-worker-get-script-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Fetch script content (Workers for Platforms)
content:
string:
schema:
example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
4XX:
description: Fetch script content failure (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Put Script Content (Workers for Platforms)
description: Put script content for a script uploaded to a Workers for Platforms namespace.
operationId: namespace-worker-put-script-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: CF-WORKER-BODY-PART
in: header
description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
schema:
type: string
- name: CF-WORKER-MAIN-MODULE-PART
in: header
description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
:
type: array
description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name.
items:
type: string
format: binary
metadata:
type: object
description: JSON encoded metadata about the uploaded parts and Worker configuration.
properties:
body_part:
type: string
description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
example: worker.js
main_module:
type: string
description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
example: worker.js
encoding:
:
contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream
responses:
'200':
description: Put script content (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-response-single'
4XX:
description: Put script content failure (Workers for Platforms)
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings:
get:
tags:
- Accounts
summary: Cloudflare Get Script Settings
description: Get script settings from a script uploaded to a Workers for Platforms namespace.
operationId: namespace-worker-get-script-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Fetch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Fetch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Script Settings
description: Patch script metadata, such as bindings
operationId: namespace-worker-patch-script-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: dispatch_namespace
in: path
required: true
schema:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
responses:
'200':
description: Patch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Patch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/domains:
get:
tags:
- Accounts
summary: Cloudflare List Domains
description: Lists all Worker Domains for an account.
operationId: worker-domain-list-domains
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_account_identifier'
- name: zone_name
in: query
schema:
$ref: '#/components/schemas/workers_zone_name'
- name: service
in: query
schema:
$ref: '#/components/schemas/workers_schemas-service'
- name: zone_id
in: query
schema:
$ref: '#/components/schemas/workers_zone_identifier'
- name: hostname
in: query
schema:
type: string
description: Hostname of the Worker Domain.
example: foo.example.com
- name: environment
in: query
schema:
type: string
description: Worker environment associated with the zone and hostname.
example: production
responses:
'200':
description: List Domains response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_domain-response-collection'
4XX:
description: List Domains response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_domain-response-collection'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Attach to Domain
description: Attaches a Worker to a zone and hostname.
operationId: worker-domain-attach-to-domain
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- zone_id
- hostname
- service
- environment
properties:
environment:
$ref: '#/components/schemas/workers_schemas-environment'
hostname:
$ref: '#/components/schemas/workers_hostname'
service:
$ref: '#/components/schemas/workers_schemas-service'
zone_id:
$ref: '#/components/schemas/workers_zone_identifier'
responses:
'200':
description: Attach to Domain response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_domain-response-single'
4XX:
description: Attach to Domain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_domain-response-single'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/domains/{domain_id}:
delete:
tags:
- Accounts
summary: Cloudflare Detach from Domain
description: Detaches a Worker from a zone and hostname.
operationId: worker-domain-detach-from-domain
parameters:
- name: domain_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_domain_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Detach from Domain response
content:
application/json: {}
4XX:
description: Detach from Domain response failure
content:
application/json: {}
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Domain
description: Gets a Worker domain.
operationId: worker-domain-get-a-domain
parameters:
- name: domain_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_domain_identifier'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_account_identifier'
responses:
'200':
description: Get a Domain response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_domain-response-single'
4XX:
description: Get a Domain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_domain-response-single'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/durable_objects/namespaces:
get:
tags:
- Accounts
summary: Cloudflare List Namespaces
description: Returns the Durable Object namespaces owned by an account.
operationId: durable-objects-namespace-list-namespaces
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Namespaces response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_namespace'
4XX:
description: List Namespaces response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_namespace'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects:
get:
tags:
- Accounts
summary: Cloudflare List Objects
description: Returns the Durable Objects in a given namespace.
operationId: durable-objects-namespace-list-objects
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_schemas-id'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: limit
in: query
schema:
type: number
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.
default: 1000
minimum: 10
maximum: 10000
- name: cursor
in: query
schema:
type: string
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
responses:
'200':
description: List Objects response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_object'
result_info:
properties:
count:
type: number
description: Total results returned based on your list parameters.
example: 1
cursor:
$ref: '#/components/schemas/workers_cursor'
4XX:
description: List Objects response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_object'
result_info:
properties:
count:
type: number
description: Total results returned based on your list parameters.
example: 1
cursor:
$ref: '#/components/schemas/workers_cursor'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/queues:
get:
tags:
- Accounts
summary: Cloudflare List Queues
description: Returns the queues owned by an account.
operationId: queue-list-queues
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Queues response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- properties:
errors:
type: array
nullable: true
items: {}
- properties:
messages:
type: array
nullable: true
items: {}
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
total_pages:
example: 1
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
- producers_total_count
- producers
- consumers_total_count
- consumers
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_queue'
4XX:
description: List Queues response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- properties:
errors:
type: array
nullable: true
items: {}
- properties:
messages:
type: array
nullable: true
items: {}
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
total_pages:
example: 1
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
- producers_total_count
- producers
- consumers_total_count
- consumers
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_queue'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Queue
description: Creates a new queue.
operationId: queue-create-queue
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example:
queue_name: example-queue
responses:
'200':
description: Create Queue response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue_created'
type: object
4XX:
description: Create Queue response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue_created'
type: object
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/queues/{name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Queue
description: Deletes a queue.
operationId: queue-delete-queue
parameters:
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Queue response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
nullable: true
properties:
result:
type: array
nullable: true
items: {}
4XX:
description: Delete Queue response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
nullable: true
properties:
result:
type: array
nullable: true
items: {}
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Queue Details
description: Get information about a specific queue.
operationId: queue-queue-details
parameters:
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Queue Details response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue'
type: object
4XX:
description: Queue Details response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue'
type: object
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Queue
description: Updates a queue.
operationId: queue-update-queue
parameters:
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example:
queue_name: renamed-example-queue
responses:
'200':
description: Update Queue response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue_updated'
type: object
4XX:
description: Update Queue response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_id
- queue_name
- created_on
- modified_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_queue_updated'
type: object
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/queues/{name}/consumers:
get:
tags:
- Accounts
summary: Cloudflare List Queue Consumers
description: Returns the consumers for a queue.
operationId: queue-list-queue-consumers
parameters:
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Queue Consumers response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- properties:
errors:
type: array
nullable: true
items: {}
- properties:
messages:
type: array
nullable: true
items: {}
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
total_pages:
example: 1
- type: object
required:
- queue_name
- created_on
- settings
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_consumer'
4XX:
description: List Queue Consumers response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- properties:
errors:
type: array
nullable: true
items: {}
- properties:
messages:
type: array
nullable: true
items: {}
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
total_pages:
example: 1
- type: object
required:
- queue_name
- created_on
- settings
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_consumer'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Queue Consumer
description: Creates a new consumer for a queue.
operationId: queue-create-queue-consumer
parameters:
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
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
responses:
'200':
description: Create Queue Consumer response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_name
- script_name
- settings
- dead_letter_queue
- created_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_consumer_created'
type: object
4XX:
description: Create Queue Consumer response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_name
- script_name
- settings
- dead_letter_queue
- created_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_consumer_created'
type: object
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/queues/{name}/consumers/{consumer_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Queue Consumer
description: Deletes the consumer for a queue.
operationId: queue-delete-queue-consumer
parameters:
- name: consumer_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_consumer_name'
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Queue Consumer response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
nullable: true
properties:
result:
type: array
nullable: true
items: {}
4XX:
description: Delete Queue Consumer response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
nullable: true
properties:
result:
type: array
nullable: true
items: {}
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Queue Consumer
description: Updates the consumer for a queue, or creates one if it does not exist.
operationId: queue-update-queue-consumer
parameters:
- name: consumer_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_consumer_name'
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example:
dead_letter_queue: updated-example-dlq
environment: production
script_name: example-consumer
settings:
batch_size: 100
responses:
'200':
description: Update Queue Consumer response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_name
- script_name
- settings
- dead_letter_queue
- created_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_consumer_updated'
type: object
4XX:
description: Update Queue Consumer response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/workers_api-response-collection'
- type: object
required:
- queue_name
- script_name
- settings
- dead_letter_queue
- created_on
properties:
result:
allOf:
- $ref: '#/components/schemas/workers_consumer_updated'
type: object
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts:
get:
tags:
- Accounts
summary: Cloudflare List Workers
description: Fetch a list of uploaded workers.
operationId: worker-script-list-workers
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Workers response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-response-collection'
4XX:
description: List Workers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_script-response-collection'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Worker
description: Delete your worker. This call has no response body on a successful delete.
operationId: worker-script-delete-worker
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: force
in: query
description: If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.
schema:
type: boolean
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Worker response
content:
application/json: {}
4XX:
description: Delete Worker response failure
content:
application/json: {}
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Download Worker
description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
operationId: worker-script-download-worker
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Download Worker response
content:
undefined:
schema:
example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
4XX:
description: Download Worker response failure
content:
undefined:
schema:
example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Upload Worker Module
description: Upload a worker module.
operationId: worker-script-upload-worker-module
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: rollback_to
in: query
description: Rollback to provided deployment based on deployment ID. Request body will only parse a "message" part. You can learn more about deployments [here](https://developers.cloudflare.com/workers/platform/deployments/).
schema:
$ref: '#/components/schemas/workers_uuid'
requestBody:
$ref: '#/components/requestBodies/workers_script_upload'
responses:
'200':
description: Upload Worker Module response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_script-response-single'
- example:
errors: []
messages: []
result:
created_on: '2022-05-05T05:15:11.602148Z'
etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
handlers:
- fetch
id: this-is_my_script-01
logpush: false
modified_on: '2022-05-20T19:02:56.446492Z'
placement_mode: smart
tail_consumers:
- environment: production
service: my-log-consumer
usage_model: bundled
success: true
4XX:
description: Upload Worker Module response failure
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
logpush: false
modified_on: '2022-05-20T19:02:56.446492Z'
tail_consumers:
- environment: production
service: my-log-consumer
usage_model: bundled
success: true
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/content:
put:
tags:
- Accounts
summary: Cloudflare Put script content
description: Put script content without touching config or metadata
operationId: worker-script-put-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: CF-WORKER-BODY-PART
in: header
description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
schema:
type: string
- name: CF-WORKER-MAIN-MODULE-PART
in: header
description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
:
type: array
description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name.
items:
type: string
format: binary
metadata:
type: object
description: JSON encoded metadata about the uploaded parts and Worker configuration.
properties:
body_part:
type: string
description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
example: worker.js
main_module:
type: string
description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
example: worker.js
encoding:
:
contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream
responses:
'200':
description: Put script content
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-response-single'
4XX:
description: Put script content failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/content/v2:
get:
tags:
- Accounts
summary: Cloudflare Get script content
description: Fetch script content only
operationId: worker-script-get-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Fetch script content
content:
string:
schema:
example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
4XX:
description: Fetch script content failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/schedules:
get:
tags:
- Accounts
summary: Cloudflare Get Cron Triggers
description: Fetches Cron Triggers for a Worker.
operationId: worker-cron-trigger-get-cron-triggers
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Get Cron Triggers response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_cron-trigger-response-collection'
4XX:
description: Get Cron Triggers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_cron-trigger-response-collection'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Cron Triggers
description: Updates Cron Triggers for a Worker.
operationId: worker-cron-trigger-update-cron-triggers
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example: '[{''cron'': ''*/30 * * * *''}]'
responses:
'200':
description: Update Cron Triggers response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_cron-trigger-response-collection'
4XX:
description: Update Cron Triggers response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_cron-trigger-response-collection'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/settings:
get:
tags:
- Accounts
summary: Cloudflare Get Script Settings
description: Get script metadata and config, such as bindings or usage model
operationId: worker-script-get-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
responses:
'200':
description: Fetch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Fetch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Script Settings
description: Patch script metadata or config, such as bindings or usage model
operationId: worker-script-patch-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
settings:
$ref: '#/components/schemas/workers_script-settings-response'
responses:
'200':
description: Patch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Patch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/tails:
get:
tags:
- Accounts
summary: Cloudflare List Tails
description: Get list of tails currently deployed on a Worker.
operationId: worker-tail-logs-list-tails
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: List Tails response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_tail-response'
4XX:
description: List Tails response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_tail-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Start Tail
description: Starts a tail that receives logs and exception from a Worker.
operationId: worker-tail-logs-start-tail
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Start Tail response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_tail-response'
4XX:
description: Start Tail response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_tail-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/tails/{id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Tail
description: Deletes a tail from a Worker.
operationId: worker-tail-logs-delete-tail
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_id'
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Tail response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
4XX:
description: Delete Tail response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/scripts/{script_name}/usage-model:
get:
tags:
- Accounts
summary: Cloudflare Fetch Usage Model
description: Fetches the Usage Model for a given Worker.
operationId: worker-script-fetch-usage-model
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Fetch Usage Model response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_usage-model-response'
4XX:
description: Fetch Usage Model response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_usage-model-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Usage Model
description: Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.
operationId: worker-script-update-usage-model
parameters:
- name: script_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_script_name'
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example: '{''usage_model'': ''unbound''}'
responses:
'200':
description: Update Usage Model response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_usage-model-response'
4XX:
description: Update Usage Model response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_usage-model-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content:
get:
tags:
- Accounts
summary: Cloudflare Get script content
description: Get script content from a worker with an environment
operationId: worker-environment-get-script-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: service_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_service'
- name: environment_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_environment'
responses:
'200':
description: Get script content
content:
string:
schema:
example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
4XX:
description: Get script content failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Put script content
description: Put script content from a worker with an environment
operationId: worker-environment-put-script-content
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: service_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_service'
- name: environment_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_environment'
- name: CF-WORKER-BODY-PART
in: header
description: The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.
schema:
type: string
- name: CF-WORKER-MAIN-MODULE-PART
in: header
description: The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
:
type: array
description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present. This should be referenced either in the metadata as `main_module` (esm)/`body_part` (service worker) or as a header `CF-WORKER-MAIN-MODULE-PART` (esm) /`CF-WORKER-BODY-PART` (service worker) by part name.
items:
type: string
format: binary
metadata:
type: object
description: JSON encoded metadata about the uploaded parts and Worker configuration.
properties:
body_part:
type: string
description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
example: worker.js
main_module:
type: string
description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
example: worker.js
encoding:
:
contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream
responses:
'200':
description: Put script content
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-response-single'
4XX:
description: Put script content failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings:
get:
tags:
- Accounts
summary: Cloudflare Get Script Settings
description: Get script settings from a worker with an environment
operationId: worker-script-environment-get-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: service_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_service'
- name: environment_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_environment'
responses:
'200':
description: Fetch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Fetch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Patch Script Settings
description: Patch script metadata, such as bindings
operationId: worker-script-environment-patch-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
- name: service_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_service'
- name: environment_name
in: path
required: true
schema:
$ref: '#/components/schemas/workers_environment'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
responses:
'200':
description: Patch script settings
content:
application/json:
schema:
$ref: '#/components/schemas/workers_script-settings-response'
4XX:
description: Patch script settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/workers_api-response-common'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/workers/subdomain:
get:
tags:
- Accounts
summary: Cloudflare Get Subdomain
description: Returns a Workers subdomain for an account.
operationId: worker-subdomain-get-subdomain
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
responses:
'200':
description: Get Subdomain response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_subdomain-response'
4XX:
description: Get Subdomain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_subdomain-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Create Subdomain
description: Creates a Workers subdomain for an account.
operationId: worker-subdomain-create-subdomain
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/workers_identifier'
requestBody:
required: true
content:
application/json:
schema:
example: '{''subdomain'': ''example-subdomain''}'
responses:
'200':
description: Create Subdomain response
content:
application/json:
schema:
$ref: '#/components/schemas/workers_subdomain-response'
4XX:
description: Create Subdomain response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_subdomain-response'
- $ref: '#/components/schemas/workers_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_id}/zerotrust/connectivity_settings:
get:
tags:
- Accounts
summary: Cloudflare Get Zero Trust Connectivity Settings
description: Gets the Zero Trust Connectivity Settings for the given account.
operationId: zero-trust-accounts-get-connectivity-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
responses:
'200':
description: Get Zero Trust Connectivity Settings response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response'
4XX:
description: Get Zero Trust Connectivity Settings response failure
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Updates the Zero Trust Connectivity Settings
description: Updates the Zero Trust Connectivity Settings for the given account.
operationId: zero-trust-accounts-patch-connectivity-settings
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#/components/schemas/tunnel_cf_account_id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
icmp_proxy_enabled:
$ref: '#/components/schemas/tunnel_icmp_proxy_enabled'
offramp_warp_enabled:
$ref: '#/components/schemas/tunnel_offramp_warp_enabled'
responses:
'200':
description: Update Zero Trust Connectivity Settings response
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_zero_trust_connectivity_settings_response'
4XX:
description: Update Zero Trust Connectivity Settings response failure
content:
application/json:
schema:
$ref: '#/components/schemas/tunnel_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/billing/profile:
get:
tags:
- Accounts
summary: Cloudflare Billing Profile Details
description: Gets the current billing profile for the account.
operationId: account-billing-profile-(-deprecated)-billing-profile-details
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_account_identifier'
responses:
'200':
description: Billing Profile Details response
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_billing_response_single'
4XX:
description: Billing Profile Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bill-subs-api_billing_response_single'
- $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_identifier}/cloudforce-one/requests:
post:
tags:
- Accounts
summary: Cloudflare List Requests
operationId: cloudforce-one-request-list
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-list'
responses:
'200':
description: List requests response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/cloudforce-one_request-list-item'
4XX:
description: Create response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Request
operationId: cloudforce-one-request-delete
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
responses:
'200':
description: Delete a request response
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common'
4XX:
description: Create response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Request
operationId: cloudforce-one-request-get
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
responses:
'200':
description: Get a request response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-item'
4XX:
description: Get a request response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Request
description: Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body
operationId: cloudforce-one-request-update
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-edit'
responses:
'200':
description: Update a request response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-item'
4XX:
description: Update request response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message:
post:
tags:
- Accounts
summary: Cloudflare List Request Messages
operationId: cloudforce-one-request-message-list
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-message-list'
responses:
'200':
description: List request messages response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/cloudforce-one_request-message-item'
4XX:
description: List requests message response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Request Message
operationId: cloudforce-one-request-message-delete
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
- name: message_identifer
in: path
required: true
schema:
type: integer
responses:
'200':
description: Delete a request message response
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common'
4XX:
description: Delete request message response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Request Message
operationId: cloudforce-one-request-message-update
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
- name: message_identifer
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-edit'
responses:
'200':
description: Update a request messeage response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-message-item'
4XX:
description: Update request message response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new:
post:
tags:
- Accounts
summary: Cloudflare Create a New Request Message
description: Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided a default will be assigned.
operationId: cloudforce-one-request-message-new
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: request_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-message-edit'
responses:
'200':
description: Create request response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-message-item'
4XX:
description: Create response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/constants:
get:
tags:
- Accounts
summary: Cloudflare Get Request Priority, Status, and TLP constants
operationId: cloudforce-one-request-constants
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
responses:
'200':
description: Get request constants response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-constants'
4XX:
description: Get request constants response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/new:
post:
tags:
- Accounts
summary: Cloudflare Create a New Request
description: Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided a default will be assigned.
operationId: cloudforce-one-request-new
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_request-edit'
responses:
'200':
description: Create request response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-item'
4XX:
description: Create response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/priority:
post:
tags:
- Accounts
summary: Cloudflare List Priority Intelligence Requirements
operationId: cloudforce-one-priority-list
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_priority-list'
responses:
'200':
description: List priorities response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/cloudforce-one_priority-item'
4XX:
description: List priorities response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Priority Intelligence Report
operationId: cloudforce-one-priority-delete
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: priority_identifer
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
responses:
'200':
description: Delete a priority response
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common'
4XX:
description: Delete a priority response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Priority Intelligence Requirement
operationId: cloudforce-one-priority-get
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: priority_identifer
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
responses:
'200':
description: Get a priority response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-item'
4XX:
description: Get a priority response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Priority Intelligence Requirement
operationId: cloudforce-one-priority-update
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
- name: priority_identifer
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_priority-edit'
responses:
'200':
description: Update a priority response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-item'
4XX:
description: Update a priority response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/priority/new:
post:
tags:
- Accounts
summary: Cloudflare Create a New Priority Requirement
operationId: cloudforce-one-priority-new
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_priority-edit'
responses:
'200':
description: Create priority response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_priority-item'
4XX:
description: Create priority response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/priority/quota:
get:
tags:
- Accounts
summary: Cloudflare Get Priority Intelligence Requirement Quota
operationId: cloudforce-one-priority-quota
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
responses:
'200':
description: Get priority quota response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_quota'
4XX:
description: Get priority quota response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/quota:
get:
tags:
- Accounts
summary: Cloudflare Get Request Quota
operationId: cloudforce-one-request-quota
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
responses:
'200':
description: Get request quota response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_quota'
4XX:
description: Get request quota response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/cloudforce-one/requests/types:
get:
tags:
- Accounts
summary: Cloudflare Get Request Types
operationId: cloudforce-one-request-types
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/cloudforce-one_identifier'
responses:
'200':
description: Get request types response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
result:
$ref: '#/components/schemas/cloudforce-one_request-types'
4XX:
description: Get request types response failure
content:
application/json:
schema:
$ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/custom_pages:
get:
tags:
- Accounts
summary: Cloudflare List custom pages
description: Fetches all the custom pages at the account level.
operationId: custom-pages-for-an-account-list-custom-pages
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/custom-pages_identifier'
responses:
'200':
description: List custom pages response
content:
application/json:
schema:
$ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
4xx:
description: List custom pages response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
- $ref: '#/components/schemas/custom-pages_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_identifier}/custom_pages/{identifier}:
get:
tags:
- Accounts
summary: Cloudflare Get a custom page
description: Fetches the details of a custom page.
operationId: custom-pages-for-an-account-get-a-custom-page
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/custom-pages_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/custom-pages_identifier'
responses:
'200':
description: Get a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/custom-pages_custom_pages_response_single'
4xx:
description: Get a custom page response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
- $ref: '#/components/schemas/custom-pages_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update a custom page
description: Updates the configuration of an existing custom page.
operationId: custom-pages-for-an-account-update-a-custom-page
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/custom-pages_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/custom-pages_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- url
- state
properties:
state:
$ref: '#/components/schemas/custom-pages_state'
url:
$ref: '#/components/schemas/custom-pages_url'
responses:
'200':
description: Update a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/custom-pages_custom_pages_response_single'
4xx:
description: Update a custom page response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
- $ref: '#/components/schemas/custom-pages_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_identifier}/d1/database/{database_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete D1 Database
description: Deletes the specified D1 database.
operationId: cloudflare-d1-delete-database
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_account-identifier'
- name: database_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_database-identifier'
responses:
'200':
description: Delete D1 database response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- properties:
result:
type: object
nullable: true
4XX:
description: Delete D1 database response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/d1_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get D1 Database
description: Returns the specified D1 database.
operationId: cloudflare-d1-get-database
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_account-identifier'
- name: database_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_database-identifier'
responses:
'200':
description: Database details response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- properties:
result:
$ref: '#/components/schemas/d1_database-details-response'
4XX:
description: Database details response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/d1_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/d1/database/{database_identifier}/query:
post:
tags:
- Accounts
summary: Cloudflare Query D1 Database
description: Returns the query result.
operationId: cloudflare-d1-query-database
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_account-identifier'
- name: database_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/d1_database-identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sql
properties:
params:
$ref: '#/components/schemas/d1_params'
sql:
$ref: '#/components/schemas/d1_sql'
responses:
'200':
description: Query response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/d1_query-result-response'
4XX:
description: Query response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/d1_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/d1_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report:
get:
tags:
- Accounts
summary: Cloudflare Table
description: 'Retrieves a list of summarised aggregate metrics over a given time period.
See [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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_identifier'
- name: metrics
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_metrics'
- name: dimensions
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_dimensions'
- name: since
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_since'
- name: until
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_until'
- name: limit
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_limit'
- name: sort
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_sort'
- name: filters
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_filters'
responses:
'200':
description: Table response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns_dns_analytics_api_report'
4XX:
description: Table response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns_dns_analytics_api_report'
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime:
get:
tags:
- Accounts
summary: Cloudflare By Time
description: 'Retrieves a list of aggregate metrics grouped by time interval.
See [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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_identifier'
- name: metrics
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_metrics'
- name: dimensions
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_dimensions'
- name: since
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_since'
- name: until
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_until'
- name: limit
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_limit'
- name: sort
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_sort'
- name: filters
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_filters'
- name: time_delta
in: query
schema:
$ref: '#/components/schemas/dns_dns_analytics_api_time_delta'
responses:
'200':
description: By Time response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns_dns_analytics_api_report_bytime'
4XX:
description: By Time response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns_dns_analytics_api_report_bytime'
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/email/routing/addresses:
get:
tags:
- Accounts
summary: Cloudflare List destination addresses
description: Lists existing destination addresses.
operationId: email-routing-destination-addresses-list-destination-addresses
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_identifier'
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results per page.
default: 20
minimum: 5
maximum: 50
- name: direction
in: query
schema:
type: string
description: Sorts results in an ascending or descending order.
enum:
- asc
- desc
default: asc
example: asc
- name: verified
in: query
schema:
type: boolean
description: Filter by verified destination addresses.
enum:
- true
- false
default: true
example: true
responses:
'200':
description: List destination addresses response
content:
application/json:
schema:
$ref: '#/components/schemas/email_destination_addresses_response_collection'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a destination address
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/email_create_destination_address_properties'
responses:
'200':
description: Create a destination address response
content:
application/json:
schema:
$ref: '#/components/schemas/email_destination_address_response_single'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete destination address
description: Deletes a specific destination address.
operationId: email-routing-destination-addresses-delete-destination-address
parameters:
- name: destination_address_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_destination_address_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_identifier'
responses:
'200':
description: Delete destination address response
content:
application/json:
schema:
$ref: '#/components/schemas/email_destination_address_response_single'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a destination address
description: Gets information for a specific destination email already created.
operationId: email-routing-destination-addresses-get-a-destination-address
parameters:
- name: destination_address_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_destination_address_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/email_identifier'
responses:
'200':
description: Get a destination address response
content:
application/json:
schema:
$ref: '#/components/schemas/email_destination_address_response_single'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/firewall/access_rules/rules:
get:
tags:
- Accounts
summary: Cloudflare List IP Access rules
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_account_identifier'
- name: filters
in: query
schema:
$ref: '#/components/schemas/legacy-jhs_schemas-filters'
- name: egs-pagination.json
in: query
schema:
$ref: '#/components/schemas/legacy-jhs_egs-pagination'
- name: page
in: query
schema:
type: number
description: Requested page within paginated list of results.
example: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results requested.
example: 20
- name: order
in: query
schema:
type: string
description: The field used to sort returned rules.
enum:
- configuration.target
- configuration.value
- mode
example: mode
- name: direction
in: query
schema:
type: string
description: The direction used to sort returned rules.
enum:
- asc
- desc
example: desc
responses:
'200':
description: List IP Access rules response
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_response_collection'
4xx:
description: List IP Access rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/legacy-jhs_response_collection'
- $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create an IP Access rule
description: 'Creates a new IP Access rule for an account. The rule will apply to all zones in the account.
Note: 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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- mode
- configuration
properties:
configuration:
$ref: '#/components/schemas/legacy-jhs_schemas-configuration'
mode:
$ref: '#/components/schemas/legacy-jhs_schemas-mode'
notes:
$ref: '#/components/schemas/legacy-jhs_notes'
responses:
'200':
description: Create an IP Access rule response
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_response_single'
4xx:
description: Create an IP Access rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/legacy-jhs_response_single'
- $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an IP Access rule
description: 'Deletes an existing IP Access rule defined at the account level.
Note: This operation will affect all zones in the account.'
operationId: ip-access-rules-for-an-account-delete-an-ip-access-rule
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_schemas-identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete an IP Access rule response
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_api-response-single-id'
4xx:
description: Delete an IP Access rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-single-id'
- $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
get:
tags:
- Accounts
summary: Cloudflare Get an IP Access rule
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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_schemas-identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_account_identifier'
responses:
'200':
description: Get an IP Access rule response
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_response_single'
4xx:
description: Get an IP Access rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/legacy-jhs_response_single'
- $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
patch:
tags:
- Accounts
summary: Cloudflare Update an IP Access rule
description: 'Updates an IP Access rule defined at the account level.
Note: This operation will affect all zones in the account.'
operationId: ip-access-rules-for-an-account-update-an-ip-access-rule
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_schemas-identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/legacy-jhs_account_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_schemas-rule'
responses:
'200':
description: Update an IP Access rule response
content:
application/json:
schema:
$ref: '#/components/schemas/legacy-jhs_response_single'
4xx:
description: Update an IP Access rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/legacy-jhs_response_single'
- $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
security:
- api_email: []
api_key: []
- api_token: []
/accounts/{account_identifier}/magic/cf_interconnects:
get:
tags:
- Accounts
summary: Cloudflare List interconnects
description: Lists interconnects associated with an account.
operationId: magic-interconnects-list-interconnects
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List interconnects response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
4xx:
description: List interconnects response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_components-schemas-tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update multiple interconnects
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- id
responses:
'200':
description: Update multiple interconnects response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
4xx:
description: Update multiple interconnects response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_components-schemas-modified_tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}:
get:
tags:
- Accounts
summary: Cloudflare List interconnect Details
description: Lists details for a specific interconnect.
operationId: magic-interconnects-list-interconnect-details
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List interconnect Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
4xx:
description: List interconnect Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_components-schemas-tunnel_single_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update interconnect
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:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_components-schemas-tunnel_update_request'
responses:
'200':
description: Update interconnect response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
4xx:
description: Update interconnect response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_components-schemas-tunnel_modified_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/gre_tunnels:
get:
tags:
- Accounts
summary: Cloudflare List GRE tunnels
description: Lists GRE tunnels associated with an account.
operationId: magic-gre-tunnels-list-gre-tunnels
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List GRE tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnels_collection_response'
4XX:
description: List GRE tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create GRE tunnels
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- customer_gre_endpoint
- cloudflare_gre_endpoint
- interface_address
responses:
'200':
description: Create GRE tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnels_collection_response'
4XX:
description: Create GRE tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update multiple GRE tunnels
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- id
responses:
'200':
description: Update multiple GRE tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_modified_tunnels_collection_response'
4XX:
description: Update multiple GRE tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_modified_tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete GRE Tunnel
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:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete GRE Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnel_deleted_response'
4XX:
description: Delete GRE Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_tunnel_deleted_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List GRE Tunnel Details
description: Lists informtion for a specific GRE tunnel.
operationId: magic-gre-tunnels-list-gre-tunnel-details
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List GRE Tunnel Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnel_single_response'
4XX:
description: List GRE Tunnel Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_tunnel_single_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update GRE Tunnel
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:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnel_update_request'
responses:
'200':
description: Update GRE Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_tunnel_modified_response'
4XX:
description: Update GRE Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_tunnel_modified_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/ipsec_tunnels:
get:
tags:
- Accounts
summary: Cloudflare List IPsec tunnels
description: Lists IPsec tunnels associated with an account.
operationId: magic-ipsec-tunnels-list-ipsec-tunnels
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List IPsec tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
4XX:
description: List IPsec tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create IPsec tunnels
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-ipsec-tunnels-create-ipsec-tunnels
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnel_add_request'
responses:
'200':
description: Create IPsec tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
4XX:
description: Create IPsec tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update multiple IPsec tunnels
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-ipsec-tunnels-update-multiple-ipsec-tunnels
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- id
responses:
'200':
description: Update multiple IPsec tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
4XX:
description: Update multiple IPsec tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete IPsec Tunnel
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-ipsec-tunnels-delete-ipsec-tunnel
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete IPsec Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
4XX:
description: Delete IPsec Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List IPsec tunnel details
description: Lists details for a specific IPsec tunnel.
operationId: magic-ipsec-tunnels-list-ipsec-tunnel-details
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List IPsec tunnel details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnel_single_response'
4XX:
description: List IPsec tunnel details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnel_single_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update IPsec Tunnel
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-ipsec-tunnels-update-ipsec-tunnel
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnel_update_request'
responses:
'200':
description: Update IPsec Tunnel response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
4XX:
description: Update IPsec Tunnel response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate:
post:
tags:
- Accounts
summary: Cloudflare Generate Pre Shared Key (PSK) for IPsec tunnels
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-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels
parameters:
- name: tunnel_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Generate Pre Shared Key (PSK) for IPsec tunnels response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_psk_generation_response'
4xx:
description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_psk_generation_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/routes:
delete:
tags:
- Accounts
summary: Cloudflare Delete Many Routes
description: Delete multiple Magic static routes.
operationId: magic-static-routes-delete-many-routes
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_delete_many_request'
responses:
'200':
description: Delete Many Routes response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_multiple_route_delete_response'
4XX:
description: Delete Many Routes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_multiple_route_delete_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List Routes
description: List all Magic static routes.
operationId: magic-static-routes-list-routes
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List Routes response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_routes_collection_response'
4XX:
description: List Routes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_routes_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Routes
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- prefix
- nexthop
- priority
responses:
'200':
description: Create Routes response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_routes_collection_response'
4XX:
description: Create Routes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_routes_collection_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Many Routes
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_update_many_request'
responses:
'200':
description: Update Many Routes response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_multiple_route_modified_response'
4XX:
description: Update Many Routes response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_multiple_route_modified_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/routes/{route_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Route
description: Disable and remove a specific Magic static route.
operationId: magic-static-routes-delete-route
parameters:
- name: route_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Route response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_deleted_response'
4XX:
description: Delete Route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_route_deleted_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Route Details
description: Get a specific Magic static route.
operationId: magic-static-routes-route-details
parameters:
- name: route_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: Route Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_single_response'
4XX:
description: Route Details response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_route_single_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Route
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:
- name: route_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_update_request'
responses:
'200':
description: Update Route response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_route_modified_response'
4XX:
description: Update Route response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic_route_modified_response'
- $ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites:
get:
tags:
- Accounts
summary: Cloudflare List Sites
description: Lists Sites associated with an account. Use connector_identifier query param to return sites where connector_identifier matches either site.ConnectorID or site.SecondaryConnectorID.
operationId: magic-wan-sites-list-sites
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: connector_identifier
in: query
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List Sites response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_sites_collection_response'
4XX:
description: List Sites response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a new Site
description: Creates a new Site
operationId: magic-sites-create-site
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_sites_add_single_request'
responses:
'200':
description: Create Site response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_site_single_response'
4XX:
description: Create Site response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Site
description: Remove a specific Site.
operationId: magic-sites-delete-site
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Site response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_site_deleted_response'
4XX:
description: Delete Site response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Site Details
description: Get a specific Site.
operationId: magic-sites-site-details
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: Site Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_site_single_response'
4XX:
description: Site Details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Site
description: Update a specific Site.
operationId: magic-sites-update-site
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_site_update_request'
responses:
'200':
description: Update Site response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_site_modified_response'
4XX:
description: Update Site response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/acls:
get:
tags:
- Accounts
summary: Cloudflare List Site ACLs
description: Lists Site ACLs associated with an account.
operationId: magic-site-acls-list-acls
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List Site ACLs response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acls_collection_response'
4XX:
description: List Site ACLs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a new Site ACL
description: Creates a new Site ACL.
operationId: magic-site-acls-create-site-acl
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acls_add_single_request'
responses:
'200':
description: Create Site ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acls_collection_response'
4XX:
description: Create Site ACL response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/acls/{acl_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Site ACL
description: Remove a specific Site ACL.
operationId: magic-site-acls-delete-acl
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: acl_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Site ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acl_deleted_response'
4XX:
description: Delete Site ACL response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Site ACL Details
description: Get a specific Site ACL.
operationId: magic-site-acls-acl-details
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: acl_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: Site ACL Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acl_single_response'
4XX:
description: Site ACL Details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Site ACL
description: Update a specific Site ACL.
operationId: magic-site-acls-update-acl
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: acl_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acl_update_request'
responses:
'200':
description: Update Site ACL response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_acl_modified_response'
4XX:
description: Update Site ACL response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/lans:
get:
tags:
- Accounts
summary: Cloudflare List LANs
description: Lists LANs associated with an account and site.
operationId: magic-wan-connectors-lans-list-lans
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List LANs response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lans_collection_response'
4XX:
description: List LANs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a new LAN
description: Creates a new LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.
operationId: magic-wan-connectors-lans-create-lan
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lans_add_single_request'
responses:
'200':
description: Create LAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lans_collection_response'
4XX:
description: Create LAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/lans/{lan_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete LAN
description: Remove a specific LAN.
operationId: magic-wan-connectors-lans-delete-lan
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: lan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete LAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lan_deleted_response'
4XX:
description: Delete LAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare LAN Details
description: Get a specific LAN.
operationId: magic-wan-connectors-lans-lan-details
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: lan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: LAN Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lan_single_response'
4XX:
description: LAN Details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update LAN
description: Update a specific LAN.
operationId: magic-wan-connectors-lans-update-lan
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: lan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lan_update_request'
responses:
'200':
description: Update LAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_lan_modified_response'
4XX:
description: Update LAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/wans:
get:
tags:
- Accounts
summary: Cloudflare List WANs
description: Lists WANs associated with an account and site.
operationId: magic-wan-connectors-list-wans
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: List WANs response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wans_collection_response'
4XX:
description: List WANs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a new WAN
description: Creates a new WAN.
operationId: magic-wan-connectors-create-wan
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wans_add_single_request'
responses:
'200':
description: Create WAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wans_collection_response'
4XX:
description: Create WAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/magic/sites/{site_identifier}/wans/{wan_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete WAN
description: Remove a specific WAN.
operationId: magic-wan-connectors-delete-wan
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: wan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete WAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wan_deleted_response'
4XX:
description: Delete WAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare WAN Details
description: Get a specific WAN.
operationId: magic-wan-connectors-wan-details
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: wan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
responses:
'200':
description: WAN Details response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wan_single_response'
4XX:
description: WAN Details response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update WAN
description: Update a specific WAN.
operationId: magic-wan-connectors-update-wan
parameters:
- name: site_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
- name: wan_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wan_update_request'
responses:
'200':
description: Update WAN response
content:
application/json:
schema:
$ref: '#/components/schemas/magic_wan_modified_response'
4XX:
description: Update WAN response failure
content:
application/json:
schema:
$ref: '#/components/schemas/magic_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/mnm/config:
delete:
tags:
- Accounts
summary: Cloudflare Delete account configuration
description: Delete an existing network monitoring configuration.
operationId: magic-network-monitoring-configuration-delete-account-configuration
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: Delete account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare List account configuration
description: Lists default sampling and router IPs for account.
operationId: magic-network-monitoring-configuration-list-account-configuration
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
responses:
'200':
description: List account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: List account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update account configuration fields
description: Update fields in an existing network monitoring configuration.
operationId: magic-network-monitoring-configuration-update-account-configuration-fields
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update account configuration fields response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: Update account configuration fields response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create account configuration
description: Create a new network monitoring configuration.
operationId: magic-network-monitoring-configuration-create-account-configuration
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Create account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: Create account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an entire account configuration
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:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update an entire account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: Update an entire account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/mnm/config/full:
get:
tags:
- Accounts
summary: Cloudflare List rules and account configuration
description: Lists default sampling, router IPs, and rules for account.
operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
responses:
'200':
description: List rules and account configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
4XX:
description: List rules and account configuration response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_config_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/mnm/rules:
get:
tags:
- Accounts
summary: Cloudflare List rules
description: Lists network monitoring rules for account.
operationId: magic-network-monitoring-rules-list-rules
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
responses:
'200':
description: List rules response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response'
4XX:
description: List rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_collection_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create rules
description: Create network monitoring rules for account. Currently only supports creating a single rule per API request.
operationId: magic-network-monitoring-rules-create-rules
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Create rules response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
4XX:
description: Create rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update rules
description: Update network monitoring rules for account.
operationId: magic-network-monitoring-rules-update-rules
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update rules response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
4XX:
description: Update rules response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/mnm/rules/{rule_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete rule
description: Delete a network monitoring rule for account.
operationId: magic-network-monitoring-rules-delete-rule
parameters:
- name: rule_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_rule_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete rule response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
4XX:
description: Delete rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get rule
description: List a single network monitoring rule for account.
operationId: magic-network-monitoring-rules-get-rule
parameters:
- name: rule_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_rule_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
responses:
'200':
description: Get rule response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
4XX:
description: Get rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
patch:
tags:
- Accounts
summary: Cloudflare Update rule
description: Update a network monitoring rule for account.
operationId: magic-network-monitoring-rules-update-rule
parameters:
- name: rule_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_rule_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update rule response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
4XX:
description: Update rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rules_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement:
patch:
tags:
- Accounts
summary: Cloudflare Update advertisement for rule
description: Update advertisement for rule.
operationId: magic-network-monitoring-rules-update-advertisement-for-rule
parameters:
- name: rule_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_rule_identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/magic-visibility_account_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update advertisement for rule response
content:
application/json:
schema:
$ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response'
4XX:
description: Update advertisement for rule response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/magic-visibility_mnm_rule_advertisement_single_response'
- $ref: '#/components/schemas/magic-visibility_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/request-tracer/trace:
post:
tags:
- Accounts
summary: Cloudflare Request Trace
operationId: account-request-tracer-request-trace
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/request-tracer_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
- method
properties:
body:
type: object
properties:
base64:
type: string
description: Base64 encoded request body
example: c29tZV9yZXF1ZXN0X2JvZHk=
json:
type: object
description: Arbitrary json as request body
plain_text:
type: string
description: Request body as plain text
context:
type: object
description: Additional request parameters
properties:
bot_score:
type: integer
description: Bot score used for evaluating tracing request processing
geoloc:
type: object
description: Geodata for tracing request
properties:
city:
type: string
example: London
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
skip_challenge:
type: boolean
description: 'Whether to skip any challenges for tracing request (e.g.: captcha)'
example: true
threat_score:
type: integer
description: Threat score used for evaluating tracing request processing
cookies:
type: object
description: Cookies added to tracing request
example:
cookie_name_1: cookie_value_1
cookie_name_2: cookie_value_2
headers:
type: object
description: Headers added to tracing request
example:
header_name_1: header_value_1
header_name_2: header_value_2
method:
type: string
description: HTTP Method of tracing request
example: PUT
protocol:
type: string
description: HTTP Protocol of tracing request
example: HTTP/1.1
skip_response:
type: boolean
description: Skip sending the request to the Origin server after all rules evaluation
url:
type: string
description: URL to which perform tracing request
example: https://some.zone/some_path
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
responses:
'200':
description: Request Trace response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/request-tracer_api-response-common'
- type: object
properties:
result:
type: object
description: Trace result with an origin status code
properties:
status_code:
type: integer
description: HTTP Status code of zone response
trace:
$ref: '#/components/schemas/request-tracer_trace'
type: object
4XX:
description: Request Trace response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/request-tracer_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}:
get:
tags:
- Accounts
summary: Cloudflare Get a list item
description: Fetches a list item in the list.
operationId: lists-get-a-list-item
parameters:
- name: item_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_item_id'
- name: list_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_list_id'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
responses:
'200':
description: Get a list item response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_item-response-collection'
4XX:
description: Get a list item response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_item-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}:
get:
tags:
- Accounts
summary: Cloudflare Get bulk operation status
description: 'Gets the current status of an asynchronous operation on a list.
The `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:
- name: operation_id
in: path
required: true
schema:
$ref: '#/components/schemas/lists_operation_id'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/lists_identifier'
responses:
'200':
description: Get bulk operation status response
content:
application/json:
schema:
$ref: '#/components/schemas/lists_bulk-operation-response-collection'
4XX:
description: Get bulk operation status response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/lists_bulk-operation-response-collection'
- $ref: '#/components/schemas/lists_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{account_identifier}/subscriptions:
get:
tags:
- Accounts
summary: Cloudflare List Subscriptions
description: Lists all of an account's subscriptions.
operationId: account-subscriptions-list-subscriptions
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_identifier'
responses:
'200':
description: List Subscriptions response
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_account_subscription_response_collection'
4XX:
description: List Subscriptions response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bill-subs-api_account_subscription_response_collection'
- $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create Subscription
description: Creates an account subscription.
operationId: account-subscriptions-create-subscription
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_subscription-v2'
responses:
'200':
description: Create Subscription response
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
4XX:
description: Create Subscription response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
- $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_identifier}/subscriptions/{subscription_identifier}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Subscription
description: Deletes an account's subscription.
operationId: account-subscriptions-delete-subscription
parameters:
- name: subscription_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_schemas-identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete Subscription response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-single'
- properties:
result:
type: object
properties:
subscription_id:
$ref: '#/components/schemas/bill-subs-api_schemas-identifier'
4XX:
description: Delete Subscription response failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-single'
- properties:
result:
type: object
properties:
subscription_id:
$ref: '#/components/schemas/bill-subs-api_schemas-identifier'
- $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
put:
tags:
- Accounts
summary: Cloudflare Update Subscription
description: Updates an account subscription.
operationId: account-subscriptions-update-subscription
parameters:
- name: subscription_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_schemas-identifier'
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/bill-subs-api_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_subscription-v2'
responses:
'200':
description: Update Subscription response
content:
application/json:
schema:
$ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
4XX:
description: Update Subscription response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/bill-subs-api_account_subscription_response_single'
- $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
/accounts/{account_identifier}/vectorize/indexes:
get:
tags:
- Accounts
summary: Cloudflare List Vectorize Indexes
description: Returns a list of Vectorize Indexes
operationId: vectorize-list-vectorize-indexes
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
responses:
'200':
description: List Vectorize Index Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/vectorize_create-index-response'
4XX:
description: List Vectorize Index Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create Vectorize Index
description: Creates and returns a new Vectorize Index.
operationId: vectorize-create-vectorize-index
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/vectorize_create-index-request'
responses:
'200':
description: Create Vectorize Index Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_create-index-response'
4XX:
description: Create Vectorize Index Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete Vectorize Index
description: Deletes the specified Vectorize Index.
operationId: vectorize-delete-vectorize-index
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
responses:
'200':
description: Delete Vectorize Index Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
type: object
nullable: true
4XX:
description: Delete Vectorize Index Failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get Vectorize Index
description: Returns the specified Vectorize Index.
operationId: vectorize-get-vectorize-index
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
responses:
'200':
description: Get Vectorize Index Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_create-index-response'
4XX:
description: Get Vectorize Index Failure
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update Vectorize Index
description: Updates and returns the specified Vectorize Index.
operationId: vectorize-update-vectorize-index
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/vectorize_update-index-request'
responses:
'200':
description: Update Vectorize Index Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_create-index-response'
4XX:
description: Update Vectorize Index Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}/delete-by-ids:
post:
tags:
- Accounts
summary: Cloudflare Delete Vectors By Identifier
description: Delete a set of vectors from an index by their vector identifiers.
operationId: vectorize-delete-vectors-by-id
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-request'
responses:
'200':
description: Delete Vector Identifiers Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_index-delete-vectors-by-id-response'
4XX:
description: Delete Vector Identifiers Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}/get-by-ids:
post:
tags:
- Accounts
summary: Cloudflare Get Vectors By Identifier
description: Get a set of vectors from an index by their vector identifiers.
operationId: vectorize-get-vectors-by-id
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/vectorize_index-get-vectors-by-id-request'
responses:
'200':
description: Get Vectors By Identifier Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_index-get-vectors-by-id-response'
4XX:
description: Get Vectors By Identifier Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}/insert:
post:
tags:
- Accounts
summary: Cloudflare Insert Vectors
description: Inserts vectors into the specified index and returns the count of the vectors successfully inserted.
operationId: vectorize-insert-vector
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/x-ndjson:
schema:
type: string
format: binary
description: ndjson file containing vectors to insert.
example: '@/path/to/vectors.ndjson'
responses:
'200':
description: Insert Vectors Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_index-insert-response'
4XX:
description: Insert Vectors Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}/query:
post:
tags:
- Accounts
summary: Cloudflare Query Vectors
description: Finds vectors closest to a given vector in an index.
operationId: vectorize-query-vector
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/vectorize_index-query-request'
responses:
'200':
description: Query Vectors Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_index-query-response'
4XX:
description: Query Vectors Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{account_identifier}/vectorize/indexes/{index_name}/upsert:
post:
tags:
- Accounts
summary: Cloudflare Upsert Vectors
description: Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted.
operationId: vectorize-upsert-vector
parameters:
- name: account_identifier
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_identifier'
- name: index_name
in: path
required: true
schema:
$ref: '#/components/schemas/vectorize_index-name'
requestBody:
required: true
content:
application/x-ndjson:
schema:
type: string
format: binary
description: ndjson file containing vectors to upsert.
example: '@/path/to/vectors.ndjson'
responses:
'200':
description: Insert Vectors Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- properties:
result:
$ref: '#/components/schemas/vectorize_index-upsert-response'
4XX:
description: Insert Vectors Failure Response
content:
application/json:
schema:
allOf:
- allOf:
- $ref: '#/components/schemas/vectorize_api-response-single'
- type: object
properties:
result:
type: object
nullable: true
- $ref: '#/components/schemas/vectorize_api-response-common-failure'
security:
- api_token: []
- api_email: []
api_key: []
/accounts/{accountId}/urlscanner/scan:
get:
tags:
- Accounts
summary: Cloudflare Search URL scans
description: Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path.
A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time.
operationId: urlscanner-search-scans
parameters:
- name: accountId
in: path
required: true
schema:
type: string
description: Account Id
- name: scanId
in: query
schema:
type: string
format: uuid
description: Scan uuid
- name: limit
in: query
schema:
type: integer
description: Limit the number of objects in the response.
example: 100
- name: next_cursor
in: query
schema:
type: string
description: Pagination cursor to get the next set of results.
- name: date_start
in: query
schema:
type: string
format: date-time
description: Filter scans requested after date (inclusive).
- name: date_end
in: query
schema:
type: string
format: date-time
description: Filter scans requested before date (inclusive).
- name: url
in: query
schema:
type: string
description: Filter scans by exact match URL of _any_ request made by the webpage
example: https://example.com/?hello
- name: hostname
in: query
schema:
type: string
description: Filter scans by hostname of _any_ request made by the webpage.
example: example.com
- name: path
in: query
schema:
type: string
description: Filter scans by url path of _any_ request made by the webpage.
example: /samples/subresource-integrity/
- name: ip
in: query
schema:
type: string
description: Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.
example: 1.1.1.1
- name: asn
in: query
schema:
type: string
description: Filter scans by Autonomous System Number (ASN) of _any_ request made by the webpage.
example: '13335'
- name: page_url
in: query
schema:
type: string
description: Filter scans by exact match to scanned URL (_after redirects_)
- name: page_hostname
in: query
schema:
type: string
description: Filter scans by main page hostname .
- name: page_path
in: query
schema:
type: string
description: Filter scans by exact match URL path (also supports suffix search).
- name: page_asn
in: query
schema:
type: string
description: Filter scans by main page Autonomous System Number (ASN).
- name: page_ip
in: query
schema:
type: string
description: Filter scans by main page IP address (IPv4 or IPv6).
- name: account_scans
in: query
schema:
type: boolean
description: Return only scans created by account.
- name: is_malicious
in: query
schema:
type: boolean
description: Filter scans by malicious verdict.
responses:
'200':
description: Search results
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Error
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: OK
result:
type: object
required:
- tasks
properties:
tasks:
type: array
items:
type: object
required:
- uuid
- url
- success
- time
- country
- visibility
properties:
country:
type: string
description: Alpha-2 country code
success:
type: boolean
description: Whether scan was successful or not
time:
type: string
format: date-time
description: When scan was submitted (UTC)
url:
type: string
description: Scan url (after redirects)
example: https://www.example.com/
uuid:
type: string
format: uuid
description: Scan id
visibility:
type: string
description: Visibility status.
example: public
success:
type: boolean
description: Whether search request was successful or not
'400':
description: Invalid params.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan ID is not a valid uuid.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
security:
- api_email: []
api_key: []
api_token: []
post:
tags:
- Accounts
summary: Cloudflare Create URL Scan
description: Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Accounts are limited to 1 new scan every 10 seconds and 8000 per month. If you need more, please reach out.
operationId: urlscanner-create-scan
parameters:
- name: accountId
in: path
required: true
schema:
type: string
description: Account Id
requestBody:
content:
application/json:
schema:
type: object
required:
- url
properties:
customHeaders:
type: object
description: Set custom headers
screenshotsResolutions:
type: array
description: Take multiple screenshots targeting different device types
default:
- desktop
items:
type: string
description: Device resolutions.
enum:
- desktop
- mobile
- tablet
default: desktop
url:
type: string
example: https://www.example.com
visibility:
type: string
description: The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.
enum:
- Public
- Unlisted
default: Public
responses:
'200':
description: Scan request accepted successfully.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Submission unsuccessful
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Submission successful
result:
type: object
required:
- visibility
- uuid
- url
- time
properties:
time:
type: string
format: date-time
description: Time when url was submitted for scanning.
url:
type: string
description: Canonical form of submitted URL. Use this if you want to later search by URL.
uuid:
type: string
format: uuid
description: Scan ID.
visibility:
type: string
description: Submitted visibility status.
example: Public
success:
type: boolean
'400':
description: Invalid params.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan ID is not a valid uuid.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
'409':
description: 'Scan request denied: hostname was recently scanned.'
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Submission unsuccessful
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
result:
type: object
required:
- tasks
properties:
tasks:
type: array
items:
type: object
required:
- uuid
- url
- status
- success
- errors
- time
- timeEnd
- visibility
- clientLocation
- clientType
- effectiveUrl
- scannedFrom
properties:
clientLocation:
type: string
description: Submitter location
example: PT
clientType:
type: string
enum:
- Site
- Automatic
- Api
effectiveUrl:
type: string
description: URL of the primary request, after all HTTP redirects
example: http://example.com/
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
scannedFrom:
type: object
required:
- colo
properties:
colo:
type: string
description: IATA code of Cloudflare datacenter
example: MAD
status:
type: string
enum:
- Queued
- InProgress
- InPostProcessing
- Finished
success:
type: boolean
example: true
time:
type: string
example: '2023-05-03T17:05:04.843Z'
timeEnd:
type: string
example: '2023-05-03T17:05:19.374Z'
url:
type: string
description: Submitted URL
example: http://example.com
uuid:
type: string
description: Scan ID
example: 2ee568d0-bf70-4827-b922-b7088c0f056f
visibility:
type: string
enum:
- Public
- Unlisted
success:
type: boolean
example: true
'429':
description: 'Scan request denied: rate limited.'
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Submission unsuccessful
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
example: true
security:
- api_email: []
api_key: []
api_token: []
/accounts/{accountId}/urlscanner/scan/{scanId}:
get:
tags:
- Accounts
summary: Cloudflare Get URL scan
description: Get URL scan by uuid
operationId: urlscanner-get-scan
parameters:
- name: scanId
in: path
required: true
schema:
type: string
format: uuid
description: Scan uuid
- name: accountId
in: path
required: true
schema:
type: string
description: Account Id
responses:
'200':
description: Scan has finished. It may or may not have been successful.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Error
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: OK
result:
type: object
required:
- scan
properties:
scan:
type: object
required:
- task
- meta
- page
- geo
- certificates
- performance
- verdicts
properties:
asns:
type: object
description: Dictionary of Autonomous System Numbers where ASN's are the keys
properties:
asn:
type: object
description: ASN's contacted
required:
- asn
- name
- description
- org_name
- location_alpha2
properties:
asn:
type: string
example: '15133'
description:
type: string
example: EDGECAST
location_alpha2:
type: string
example: US
name:
type: string
example: EDGECAST
org_name:
type: string
example: Edgecast Inc.
certificates:
type: array
items:
type: object
required:
- issuer
- subjectName
- validFrom
- validTo
properties:
issuer:
type: string
subjectName:
type: string
example: rkmod.somee.com
validFrom:
type: number
example: 1682684400
validTo:
type: number
example: 1696698000
domains:
type: object
properties:
example.com:
type: object
required:
- name
- type
- categories
- dns
- rank
properties:
categories:
type: object
required:
- inherited
properties:
content:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Technology
super_category_id:
type: integer
inherited:
type: object
properties:
content:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Technology
super_category_id:
type: integer
from:
type: string
example: example.com
risks:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Technology
super_category_id:
type: integer
risks:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Technology
super_category_id:
type: integer
dns:
type: array
items:
type: object
required:
- name
- address
- type
- dnssec_valid
properties:
address:
type: string
example: 93.184.216.34
dnssec_valid:
type: boolean
name:
type: string
example: example.com
type:
type: string
example: A
name:
type: string
example: example.com
rank:
type: object
required:
- name
- bucket
properties:
bucket:
type: string
example: '500'
name:
type: string
example: example.com
rank:
type: integer
description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/
type:
type: string
example: Apex domain
geo:
type: object
required:
- locations
- continents
properties:
continents:
type: array
description: GeoIP continent location
items:
type: string
description: GeoIP continent location
example: North America
locations:
type: array
description: GeoIP country location
items:
type: string
description: GeoIP country location
example: US
ips:
type: object
properties:
ip:
type: object
required:
- ip
- ipVersion
- locationAlpha2
- locationName
- subdivision1Name
- subdivision2Name
- latitude
- longitude
- continent
- geonameId
- asn
- asnName
- asnOrgName
- asnDescription
- asnLocationAlpha2
properties:
asn:
type: string
example: '15133'
asnDescription:
type: string
example: EDGECAST
asnLocationAlpha2:
type: string
example: US
asnName:
type: string
example: EDGECAST
asnOrgName:
type: string
example: Edgecast Inc.
continent:
type: string
example: North America
geonameId:
type: string
example: '6252001'
ip:
type: string
example: 2606:2800:220:1:248:1893:25c8:1946
ipVersion:
type: string
example: IPv6
latitude:
type: string
example: '39.76'
locationAlpha2:
type: string
example: US
locationName:
type: string
example: United States
longitude:
type: string
example: '-98.5'
subdivision1Name:
type: string
subdivision2Name:
type: string
links:
type: object
properties:
link:
type: object
required:
- href
- text
properties:
href:
type: string
description: Outgoing link detected in the DOM
example: https://www.iana.org/domains/example
text:
type: string
example: More information...
meta:
type: object
required:
- processors
properties:
processors:
type: object
required:
- tech
- categories
- rank
- phishing
properties:
categories:
type: object
required:
- content
- risks
properties:
content:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: integer
example: 155
name:
type: string
example: Technology
super_category_id:
type: integer
risks:
type: array
items:
type: object
required:
- id
- super_category_id
- name
properties:
id:
type: integer
example: 17
name:
type: string
example: Newly Seen Domains
super_category_id:
type: integer
example: 32
phishing:
type: array
items:
type: string
example: CredentialHarvester
rank:
type: object
required:
- name
- bucket
properties:
bucket:
type: string
example: '500'
name:
type: string
example: example.com
rank:
type: integer
description: Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/
tech:
type: array
items:
type: object
required:
- name
- slug
- categories
- confidence
- icon
- website
- evidence
properties:
categories:
type: array
items:
type: object
required:
- id
- slug
- groups
- name
- priority
properties:
groups:
type: array
items:
type: integer
id:
type: integer
example: 63
name:
type: string
example: IAAS
priority:
type: integer
example: 8
slug:
type: string
example: iaas
confidence:
type: integer
example: 100
description:
type: string
evidence:
type: object
required:
- patterns
- impliedBy
properties:
impliedBy:
type: array
items:
type: string
patterns:
type: array
items:
type: object
required:
- type
- regex
- value
- match
- name
- confidence
- version
- implies
- excludes
properties:
confidence:
type: integer
example: 100
excludes:
type: array
items:
type: string
implies:
type: array
items:
type: string
match:
type: string
example: ECS
name:
type: string
description: Header or Cookie name when set
example: server
regex:
type: string
example: ^ECS
type:
type: string
example: headers
value:
type: string
example: ECS (dcb/7EEE)
version:
type: string
icon:
type: string
example: Amazon ECS.svg
name:
type: string
example: Amazon ECS
slug:
type: string
example: amazon-ecs
website:
type: string
example: https://aws.amazon.com/ecs/
page:
type: object
required:
- url
- domain
- country
- countryLocationAlpha2
- subdivision1Name
- subdivision2name
- ip
- asn
- asnname
- asnLocationAlpha2
- cookies
- headers
- status
- js
- console
- securityViolations
properties:
asn:
type: string
example: '15133'
asnLocationAlpha2:
type: string
example: US
asnname:
type: string
example: EDGECAST
console:
type: array
items:
type: object
required:
- type
- text
- category
properties:
category:
type: string
example: network
text:
type: string
example: 'Failed to load resource: the server responded with a status of 404 (Not Found)'
type:
type: string
example: error
url:
type: string
example: http://example.com/favicon.ico
cookies:
type: array
items:
type: object
required:
- name
- value
- domain
- path
- expires
- size
- httpOnly
- secure
- session
- sameParty
- sourceScheme
- sourcePort
properties:
domain:
type: string
example: rkmod.somee.com
expires:
type: number
example: -1
httpOnly:
type: boolean
name:
type: string
example: b
path:
type: string
example: /
priority:
type: string
example: Medium
sameParty:
type: boolean
secure:
type: boolean
session:
type: boolean
example: true
size:
type: number
example: 2
sourcePort:
type: number
example: 443
sourceScheme:
type: string
example: Secure
value:
type: string
example: b
country:
type: string
example: United States
countryLocationAlpha2:
type: string
example: US
domain:
type: string
example: example.com
headers:
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
example: Content-Length
value:
type: string
example: '648'
ip:
type: string
example: 2606:2800:220:1:248:1893:25c8:1946
js:
type: object
required:
- variables
properties:
variables:
type: array
items:
type: object
required:
- name
- type
properties:
name:
type: string
example: checkFrame
type:
type: string
example: string
securityViolations:
type: array
items:
type: object
required:
- text
- category
- url
properties:
category:
type: string
example: csp
text:
type: string
example: '[Report Only] Refused to load the stylesheet ''https://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css'' because it violates the following Content Security Policy directive: ... '
url:
type: string
example: http://example.com/
status:
type: number
example: 200
subdivision1Name:
type: string
subdivision2name:
type: string
url:
type: string
example: http://example.com/
performance:
type: array
items:
type: object
required:
- name
- entryType
- startTime
- duration
- initiatorType
- nextHopProtocol
- workerStart
- redirectStart
- redirectEnd
- fetchStart
- domainLookupStart
- domainLookupEnd
- connectStart
- connectEnd
- secureConnectionStart
- requestStart
- responseStart
- responseEnd
- transferSize
- encodedBodySize
- decodedBodySize
- unloadEventStart
- unloadEventEnd
- domInteractive
- domContentLoadedEventStart
- domContentLoadedEventEnd
- domComplete
- loadEventStart
- loadEventEnd
- type
- redirectCount
properties:
connectEnd:
type: number
example: 82.59999999403954
connectStart:
type: number
example: 72.79999999701977
decodedBodySize:
type: number
example: 1256
domComplete:
type: number
example: 306
domContentLoadedEventEnd:
type: number
example: 305.8999999910593
domContentLoadedEventStart:
type: number
example: 305.8999999910593
domInteractive:
type: number
example: 305.8999999910593
domainLookupEnd:
type: number
example: 72.79999999701977
domainLookupStart:
type: number
example: 2.199999988079071
duration:
type: number
example: 306
encodedBodySize:
type: number
example: 648
entryType:
type: string
example: navigation
fetchStart:
type: number
example: 0.8999999910593033
initiatorType:
type: string
example: navigation
loadEventEnd:
type: number
example: 306
loadEventStart:
type: number
example: 306
name:
type: string
example: http://example.com/
nextHopProtocol:
type: string
example: http/1.1
redirectCount:
type: number
redirectEnd:
type: number
redirectStart:
type: number
requestStart:
type: number
example: 82.69999998807907
responseEnd:
type: number
example: 270.8999999910593
responseStart:
type: number
example: 265.69999998807907
secureConnectionStart:
type: number
startTime:
type: number
transferSize:
type: number
example: 948
type:
type: string
example: navigate
unloadEventEnd:
type: number
unloadEventStart:
type: number
workerStart:
type: number
task:
type: object
required:
- uuid
- url
- status
- success
- errors
- time
- timeEnd
- visibility
- clientLocation
- clientType
- effectiveUrl
- scannedFrom
properties:
clientLocation:
type: string
description: Submitter location
example: PT
clientType:
type: string
enum:
- Site
- Automatic
- Api
effectiveUrl:
type: string
description: URL of the primary request, after all HTTP redirects
example: http://example.com/
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
scannedFrom:
type: object
required:
- colo
properties:
colo:
type: string
description: IATA code of Cloudflare datacenter
example: MAD
status:
type: string
enum:
- Queued
- InProgress
- InPostProcessing
- Finished
success:
type: boolean
example: true
time:
type: string
example: '2023-05-03T17:05:04.843Z'
timeEnd:
type: string
example: '2023-05-03T17:05:19.374Z'
url:
type: string
description: Submitted URL
example: http://example.com
uuid:
type: string
description: Scan ID
example: 2ee568d0-bf70-4827-b922-b7088c0f056f
visibility:
type: string
enum:
- Public
- Unlisted
verdicts:
type: object
required:
- overall
properties:
overall:
type: object
required:
- malicious
- categories
- phishing
properties:
categories:
type: array
items:
type: object
required:
- id
- super_category_id
- name
properties:
id:
type: number
example: 117
name:
type: string
example: Malware
super_category_id:
type: number
example: 32
malicious:
type: boolean
description: At least one of our subsystems marked the site as potentially malicious at the time of the scan.
example: true
phishing:
type: array
items:
type: string
example: Credential Harvester
success:
type: boolean
description: Whether request was successful or not
'202':
description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: In Progress
result:
type: object
required:
- scan
properties:
scan:
type: object
required:
- task
properties:
task:
type: object
required:
- uuid
- url
- status
- success
- errors
- time
- visibility
- location
- region
- effectiveUrl
properties:
effectiveUrl:
type: string
example: http://example.com/
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
location:
type: string
example: PT
region:
type: string
example: enam
status:
type: string
example: InProgress
success:
type: boolean
example: true
time:
type: string
example: '2023-05-03T17:05:04.843Z'
url:
type: string
example: http://example.com
uuid:
type: string
example: 2ee568d0-bf70-4827-b922-b7088c0f056f
visibility:
type: string
example: Public
success:
type: boolean
description: Whether request was successful or not
'400':
description: Invalid params.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan ID is not a valid uuid.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
'404':
description: Scan not found.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan not found.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
security:
- api_email: []
api_key: []
api_token: []
/accounts/{accountId}/urlscanner/scan/{scanId}/har:
get:
tags:
- Accounts
summary: Cloudflare Get URL scan's HAR
description: Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.
operationId: urlscanner-get-scan-har
parameters:
- name: scanId
in: path
required: true
schema:
type: string
format: uuid
description: Scan uuid
- name: accountId
in: path
required: true
schema:
type: string
description: Account Id
responses:
'200':
description: Returns the scan's har.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Error
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: OK
result:
type: object
required:
- har
properties:
har:
type: object
required:
- log
properties:
log:
type: object
required:
- version
- creator
- pages
- entries
properties:
creator:
type: object
required:
- name
- version
- comment
properties:
comment:
type: string
example: https://github.com/sitespeedio/chrome-har
name:
type: string
example: chrome-har
version:
type: string
example: 0.13.1
entries:
type: array
items:
type: object
required:
- cache
- startedDateTime
- _requestId
- _initialPriority
- _priority
- pageref
- request
- time
- _initiator_type
- _resourceType
- response
- connection
- serverIPAddress
- _requestTime
properties:
_initialPriority:
type: string
example: VeryHigh
_initiator_type:
type: string
example: other
_priority:
type: string
example: VeryHigh
_requestId:
type: string
example: DDC779F0CB3746BAF283EC1A51B0F2F8
_requestTime:
type: number
example: 114135.331081
_resourceType:
type: string
example: document
cache:
type: object
connection:
type: string
example: '33'
pageref:
type: string
example: page_1
request:
type: object
required:
- method
- url
- headersSize
- bodySize
- headers
- httpVersion
properties:
bodySize:
type: number
headers:
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
example: Upgrade-Insecure-Requests
value:
type: string
example: '1'
headersSize:
type: number
example: 197
httpVersion:
type: string
example: http/1.1
method:
type: string
example: GET
url:
type: string
example: http://example.com/
response:
type: object
required:
- httpVersion
- redirectURL
- status
- statusText
- content
- headersSize
- bodySize
- headers
- _transferSize
properties:
_transferSize:
type: number
example: 1071
bodySize:
type: number
example: 648
content:
type: object
required:
- mimeType
- size
properties:
compression:
type: integer
example: 608
mimeType:
type: string
example: text/html
size:
type: number
example: 1256
headers:
type: array
items:
type: object
required:
- name
- value
properties:
name:
type: string
example: Content-Encoding
value:
type: string
example: gzip
headersSize:
type: number
example: 423
httpVersion:
type: string
example: http/1.1
redirectURL:
type: string
status:
type: number
example: 200
statusText:
type: string
example: OK
serverIPAddress:
type: string
example: 2606:2800:220:1:248:1893:25c8:1946
startedDateTime:
type: string
example: '2023-05-03T17:05:13.196Z'
time:
type: number
example: 268.64
pages:
type: array
items:
type: object
required:
- id
- startedDateTime
- title
- pageTimings
properties:
id:
type: string
example: page_1
pageTimings:
type: object
required:
- onLoad
- onContentLoad
properties:
onContentLoad:
type: number
example: 305.408
onLoad:
type: number
example: 305.169
startedDateTime:
type: string
example: '2023-05-03T17:05:13.195Z'
title:
type: string
example: http://example.com/
version:
type: string
example: '1.2'
success:
type: boolean
description: Whether search request was successful or not
'202':
description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: In Progress
result:
type: object
required:
- scan
properties:
scan:
type: object
required:
- task
properties:
task:
type: object
required:
- uuid
- url
- status
- success
- errors
- time
- visibility
- location
- region
- effectiveUrl
properties:
effectiveUrl:
type: string
example: http://example.com/
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
location:
type: string
example: PT
region:
type: string
example: enam
status:
type: string
example: InProgress
success:
type: boolean
example: true
time:
type: string
example: '2023-05-03T17:05:04.843Z'
url:
type: string
example: http://example.com
uuid:
type: string
example: 2ee568d0-bf70-4827-b922-b7088c0f056f
visibility:
type: string
example: Public
success:
type: boolean
description: Whether request was successful or not
'400':
description: Invalid params.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan ID is not a valid uuid.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
'404':
description: Scan not found.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan not found.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
security:
- api_email: []
api_key: []
api_token: []
/accounts/{accountId}/urlscanner/scan/{scanId}/screenshot:
get:
tags:
- Accounts
summary: Cloudflare Get screenshot
description: Get scan's screenshot by resolution (desktop/mobile/tablet).
operationId: urlscanner-get-scan-screenshot
parameters:
- name: scanId
in: path
required: true
schema:
type: string
format: uuid
description: Scan uuid
- name: accountId
in: path
required: true
schema:
type: string
description: Account Id
- name: resolution
in: query
schema:
type: string
description: Target device type
enum:
- desktop
- mobile
- tablet
default: desktop
responses:
'200':
description: Returns the scan's requested screenshot.
content:
image/png:
schema:
type: string
description: PNG Image
'202':
description: 'Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`.'
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
- result
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: In Progress
result:
type: object
required:
- scan
properties:
scan:
type: object
required:
- task
properties:
task:
type: object
required:
- uuid
- url
- status
- success
- errors
- time
- visibility
- location
- region
- effectiveUrl
properties:
effectiveUrl:
type: string
example: http://example.com/
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
location:
type: string
example: PT
region:
type: string
example: enam
status:
type: string
example: InProgress
success:
type: boolean
example: true
time:
type: string
example: '2023-05-03T17:05:04.843Z'
url:
type: string
example: http://example.com
uuid:
type: string
example: 2ee568d0-bf70-4827-b922-b7088c0f056f
visibility:
type: string
example: Public
success:
type: boolean
description: Whether request was successful or not
'400':
description: Invalid params.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan ID is not a valid uuid.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
'404':
description: Scan not found.
content:
application/json:
schema:
type: object
required:
- messages
- errors
- success
properties:
errors:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
example: Scan not found.
messages:
type: array
items:
type: object
required:
- message
properties:
message:
type: string
success:
type: boolean
description: Whether request was successful or not
security:
- api_email: []
api_key: []
api_token: []
/accounts/{identifier}/access/apps:
get:
tags:
- Accounts
summary: Cloudflare List Access applications
description: Lists all Access applications in an account.
operationId: access-applications-list-access-applications
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List Access applications response
content:
application/json:
schema:
$ref: '#/components/schemas/access_apps_components-schemas-response_collection'
4XX:
description: List Access applications response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add an Access Application
description: Adds a new application to Access.
operationId: access-applications-add-an-application
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/access_apps'
responses:
'201':
description: Add an application response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/access_apps_components-schemas-single_response'
- properties:
result:
$ref: '#/components/schemas/access_apps'
4XX:
description: Add a Bookmark application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{app_id}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an Access application
description: Deletes an application from Access.
operationId: access-applications-delete-an-access-application
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/access_app_id'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete an Access application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_id_response'
4XX:
description: Delete an Access application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an Access application
description: Fetches information about an Access application.
operationId: access-applications-get-an-access-application
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/access_app_id'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get an Access application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_apps_components-schemas-single_response'
4XX:
description: Get an Access application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an Access application
description: Updates an Access application.
operationId: access-applications-update-a-bookmark-application
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/access_app_id'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/access_apps'
responses:
'200':
description: Update an Access application response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/access_apps_components-schemas-single_response'
- properties:
result:
$ref: '#/components/schemas/access_apps'
4XX:
description: Update an Access application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{app_id}/revoke_tokens:
post:
tags:
- Accounts
summary: Cloudflare Revoke application tokens
description: Revokes all tokens issued for an application.
operationId: access-applications-revoke-service-tokens
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/access_app_id'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Revoke application tokens response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-empty_response'
4XX:
description: Revoke application tokens response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{app_id}/user_policy_checks:
get:
tags:
- Accounts
summary: Cloudflare Test Access policies
description: Tests if a specific user has permission to access an application.
operationId: access-applications-test-access-policies
parameters:
- name: app_id
in: path
required: true
schema:
$ref: '#/components/schemas/access_app_id'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Test Access policies response
content:
application/json:
schema:
$ref: '#/components/schemas/access_policy_check_response'
4XX:
description: Test Access policies response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{uuid}/ca:
delete:
tags:
- Accounts
summary: Cloudflare Delete a short-lived certificate CA
description: Deletes a short-lived certificate CA.
operationId: access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete a short-lived certificate CA response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-id_response'
4XX:
description: Delete a short-lived certificate CA response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a short-lived certificate CA
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:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get a short-lived certificate CA response
content:
application/json:
schema:
$ref: '#/components/schemas/access_ca_components-schemas-single_response'
4XX:
description: Get a short-lived certificate CA response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a short-lived certificate CA
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:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Create a short-lived certificate CA response
content:
application/json:
schema:
$ref: '#/components/schemas/access_ca_components-schemas-single_response'
4XX:
description: Create a short-lived certificate CA response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{uuid}/policies:
get:
tags:
- Accounts
summary: Cloudflare List Access policies
description: Lists Access policies configured for an application.
operationId: access-policies-list-access-policies
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List Access policies response
content:
application/json:
schema:
$ref: '#/components/schemas/access_policies_components-schemas-response_collection'
4XX:
description: List Access policies response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create an Access policy
description: Create a new Access policy for an application.
operationId: access-policies-create-an-access-policy
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- decision
- include
properties:
approval_groups:
$ref: '#/components/schemas/access_approval_groups'
approval_required:
$ref: '#/components/schemas/access_approval_required'
decision:
$ref: '#/components/schemas/access_decision'
exclude:
$ref: '#/components/schemas/access_schemas-exclude'
include:
$ref: '#/components/schemas/access_include'
isolation_required:
$ref: '#/components/schemas/access_isolation_required'
name:
$ref: '#/components/schemas/access_policies_components-schemas-name'
precedence:
$ref: '#/components/schemas/access_precedence'
purpose_justification_prompt:
$ref: '#/components/schemas/access_purpose_justification_prompt'
purpose_justification_required:
$ref: '#/components/schemas/access_purpose_justification_required'
require:
$ref: '#/components/schemas/access_schemas-require'
session_duration:
$ref: '#/components/schemas/access_components-schemas-session_duration'
responses:
'201':
description: Create an Access policy response
content:
application/json:
schema:
$ref: '#/components/schemas/access_policies_components-schemas-single_response'
4XX:
description: Create an Access policy response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an Access policy
description: Delete an Access policy.
operationId: access-policies-delete-an-access-policy
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: uuid1
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete an Access policy response
content:
application/json:
schema:
$ref: '#/components/schemas/access_id_response'
4XX:
description: Delete an Access policy response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an Access policy
description: Fetches a single Access policy.
operationId: access-policies-get-an-access-policy
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: uuid1
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get an Access policy response
content:
application/json:
schema:
$ref: '#/components/schemas/access_policies_components-schemas-single_response'
4XX:
description: Get an Access policy response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an Access policy
description: Update a configured Access policy.
operationId: access-policies-update-an-access-policy
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: uuid1
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- decision
- include
properties:
approval_groups:
$ref: '#/components/schemas/access_approval_groups'
approval_required:
$ref: '#/components/schemas/access_approval_required'
decision:
$ref: '#/components/schemas/access_decision'
exclude:
$ref: '#/components/schemas/access_schemas-exclude'
include:
$ref: '#/components/schemas/access_include'
isolation_required:
$ref: '#/components/schemas/access_isolation_required'
name:
$ref: '#/components/schemas/access_policies_components-schemas-name'
precedence:
$ref: '#/components/schemas/access_precedence'
purpose_justification_prompt:
$ref: '#/components/schemas/access_purpose_justification_prompt'
purpose_justification_required:
$ref: '#/components/schemas/access_purpose_justification_required'
require:
$ref: '#/components/schemas/access_schemas-require'
session_duration:
$ref: '#/components/schemas/access_components-schemas-session_duration'
responses:
'200':
description: Update an Access policy response
content:
application/json:
schema:
$ref: '#/components/schemas/access_policies_components-schemas-single_response'
4XX:
description: Update an Access policy response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/apps/ca:
get:
tags:
- Accounts
summary: Cloudflare List short-lived certificate CAs
description: Lists short-lived certificate CAs and their public keys.
operationId: access-short-lived-certificate-c-as-list-short-lived-certificate-c-as
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List short-lived certificate CAs response
content:
application/json:
schema:
$ref: '#/components/schemas/access_ca_components-schemas-response_collection'
4XX:
description: List short-lived certificate CAs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/bookmarks:
get:
tags:
- Accounts
summary: Cloudflare List Bookmark applications
description: Lists Bookmark applications.
operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_schemas-identifier'
responses:
'200':
description: List Bookmark applications response
content:
application/json:
schema:
$ref: '#/components/schemas/access_bookmarks_components-schemas-response_collection'
4XX:
description: List Bookmark applications response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/bookmarks/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a Bookmark application
description: Deletes a Bookmark application.
operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Delete a Bookmark application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_id_response'
4XX:
description: Delete a Bookmark application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a Bookmark application
description: Fetches a single Bookmark application.
operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_schemas-identifier'
responses:
'200':
description: Get a Bookmark application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
4XX:
description: Get a Bookmark application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a Bookmark application
description: Create a new Bookmark application.
operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Create a Bookmark application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
4XX:
description: Create a Bookmark application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a Bookmark application
description: Updates a configured Bookmark application.
operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_schemas-identifier'
requestBody:
required: true
content:
application/json: {}
responses:
'200':
description: Update a Bookmark application response
content:
application/json:
schema:
$ref: '#/components/schemas/access_bookmarks_components-schemas-single_response'
4XX:
description: Update a Bookmark application response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
deprecated: true
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/certificates:
get:
tags:
- Accounts
summary: Cloudflare List mTLS certificates
description: Lists all mTLS root certificates.
operationId: access-mtls-authentication-list-mtls-certificates
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List mTLS certificates response
content:
application/json:
schema:
$ref: '#/components/schemas/access_certificates_components-schemas-response_collection'
4XX:
description: List mTLS certificates response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add an mTLS certificate
description: Adds a new mTLS root certificate to Access.
operationId: access-mtls-authentication-add-an-mtls-certificate
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- certificate
properties:
associated_hostnames:
$ref: '#/components/schemas/access_associated_hostnames'
certificate:
type: string
description: The certificate content.
example: '--BEGIN CERTIFICATE--
MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10
DrUtmu/B
--END CERTIFICATE--'
name:
$ref: '#/components/schemas/access_certificates_components-schemas-name'
responses:
'201':
description: Add an mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/access_certificates_components-schemas-single_response'
4XX:
description: Add an mTLS certificate response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/certificates/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an mTLS certificate
description: Deletes an mTLS certificate.
operationId: access-mtls-authentication-delete-an-mtls-certificate
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Delete an mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-id_response'
4XX:
description: Delete an mTLS certificate response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an mTLS certificate
description: Fetches a single mTLS certificate.
operationId: access-mtls-authentication-get-an-mtls-certificate
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get an mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/access_certificates_components-schemas-single_response'
4XX:
description: Get an mTLS certificate response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an mTLS certificate
description: Updates a configured mTLS certificate.
operationId: access-mtls-authentication-update-an-mtls-certificate
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- associated_hostnames
properties:
associated_hostnames:
$ref: '#/components/schemas/access_associated_hostnames'
name:
$ref: '#/components/schemas/access_certificates_components-schemas-name'
responses:
'200':
description: Update an mTLS certificate response
content:
application/json:
schema:
$ref: '#/components/schemas/access_certificates_components-schemas-single_response'
4XX:
description: Update an mTLS certificate response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/certificates/settings:
get:
tags:
- Accounts
summary: Cloudflare List all mTLS hostname settings
description: List all mTLS hostname settings for this account.
operationId: access-mtls-authentication-list-mtls-certificates-hostname-settings
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List mTLS hostname settings response
content:
application/json:
schema:
$ref: '#/components/schemas/access_response_collection_hostnames'
4XX:
description: List mTLS hostname settings response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an mTLS certificate's hostname settings
description: Updates an mTLS certificate's hostname settings.
operationId: access-mtls-authentication-update-an-mtls-certificate-settings
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- settings
properties:
settings:
type: array
items:
$ref: '#/components/schemas/access_settings'
responses:
'202':
description: Update an mTLS certificates hostname settings response
content:
application/json:
schema:
$ref: '#/components/schemas/access_response_collection_hostnames'
4XX:
description: Update an mTLS certificates hostname settings failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/custom_pages:
get:
tags:
- Accounts
summary: Cloudflare List custom pages
description: List custom pages
operationId: access-custom-pages-list-custom-pages
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List custom pages response
content:
application/json:
schema:
$ref: '#/components/schemas/access_custom-pages_components-schemas-response_collection'
4XX:
description: List custom pages response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a custom page
description: Create a custom page
operationId: access-custom-pages-create-a-custom-page
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/access_custom_page'
responses:
'201':
description: Create a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/access_single_response_without_html'
4XX:
description: Create a custom page response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/custom_pages/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a custom page
description: Delete a custom page
operationId: access-custom-pages-delete-a-custom-page
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-id_response'
4XX:
description: Delete a custom page response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a custom page
description: Fetches a custom page and also returns its HTML.
operationId: access-custom-pages-get-a-custom-page
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/access_custom-pages_components-schemas-single_response'
4XX:
description: Get a custom page response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a custom page
description: Update a custom page
operationId: access-custom-pages-update-a-custom-page
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/access_custom_page'
responses:
'200':
description: Update a custom page response
content:
application/json:
schema:
$ref: '#/components/schemas/access_single_response_without_html'
4XX:
description: Update a custom page response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/groups:
get:
tags:
- Accounts
summary: Cloudflare List Access groups
description: Lists all Access groups.
operationId: access-groups-list-access-groups
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List Access groups response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-response_collection'
4XX:
description: List Access groups response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create an Access group
description: Creates a new Access group.
operationId: access-groups-create-an-access-group
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- include
properties:
exclude:
$ref: '#/components/schemas/access_exclude'
include:
$ref: '#/components/schemas/access_include'
is_default:
$ref: '#/components/schemas/access_is_default'
name:
$ref: '#/components/schemas/access_components-schemas-name'
require:
$ref: '#/components/schemas/access_require'
responses:
'201':
description: Create an Access group response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-single_response'
4XX:
description: Create an Access group response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/groups/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an Access group
description: Deletes an Access group.
operationId: access-groups-delete-an-access-group
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete an Access group response
content:
application/json:
schema:
$ref: '#/components/schemas/access_id_response'
4XX:
description: Delete an Access group response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an Access group
description: Fetches a single Access group.
operationId: access-groups-get-an-access-group
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get an Access group response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-single_response'
4XX:
description: Get an Access group response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an Access group
description: Updates a configured Access group.
operationId: access-groups-update-an-access-group
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- include
properties:
exclude:
$ref: '#/components/schemas/access_exclude'
include:
$ref: '#/components/schemas/access_include'
is_default:
$ref: '#/components/schemas/access_is_default'
name:
$ref: '#/components/schemas/access_components-schemas-name'
require:
$ref: '#/components/schemas/access_require'
responses:
'200':
description: Update an Access group response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-single_response'
4XX:
description: Update an Access group response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/identity_providers:
get:
tags:
- Accounts
summary: Cloudflare List Access identity providers
description: Lists all configured identity providers.
operationId: access-identity-providers-list-access-identity-providers
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List Access identity providers response
content:
application/json:
schema:
$ref: '#/components/schemas/access_response_collection'
4XX:
description: List Access identity providers response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Add an Access identity provider
description: Adds a new identity provider to Access.
operationId: access-identity-providers-add-an-access-identity-provider
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/access_identity-providers'
responses:
'201':
description: Add an Access identity provider response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-single_response'
4XX:
description: Add an Access identity provider response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/identity_providers/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete an Access identity provider
description: Deletes an identity provider from Access.
operationId: access-identity-providers-delete-an-access-identity-provider
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'202':
description: Delete an Access identity provider response
content:
application/json:
schema:
$ref: '#/components/schemas/access_id_response'
4XX:
description: Delete an Access identity provider response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get an Access identity provider
description: Fetches a configured identity provider.
operationId: access-identity-providers-get-an-access-identity-provider
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get an Access identity provider response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-single_response'
4XX:
description: Get an Access identity provider response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update an Access identity provider
description: Updates a configured identity provider.
operationId: access-identity-providers-update-an-access-identity-provider
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/access_identity-providers'
responses:
'200':
description: Update an Access identity provider response
content:
application/json:
schema:
$ref: '#/components/schemas/access_schemas-single_response'
4XX:
description: Update an Access identity provider response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/keys:
get:
tags:
- Accounts
summary: Cloudflare Get the Access key configuration
description: Gets the Access key rotation settings for an account.
operationId: access-key-configuration-get-the-access-key-configuration
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get the Access key configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/access_keys_components-schemas-single_response'
4XX:
description: Get the Access key configuration response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update the Access key configuration
description: Updates the Access key rotation settings for an account.
operationId: access-key-configuration-update-the-access-key-configuration
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- key_rotation_interval_days
properties:
key_rotation_interval_days:
$ref: '#/components/schemas/access_key_rotation_interval_days'
responses:
'200':
description: Update the Access key configuration response
content:
application/json:
schema:
$ref: '#/components/schemas/access_keys_components-schemas-single_response'
4XX:
description: Update the Access key configuration response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/keys/rotate:
post:
tags:
- Accounts
summary: Cloudflare Rotate Access keys
description: Perfoms a key rotation for an account.
operationId: access-key-configuration-rotate-access-keys
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Rotate Access keys response
content:
application/json:
schema:
$ref: '#/components/schemas/access_keys_components-schemas-single_response'
4XX:
description: Rotate Access keys response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/logs/access_requests:
get:
tags:
- Accounts
summary: Cloudflare Get Access authentication logs
description: Gets a list of Access authentication audit logs for an account.
operationId: access-authentication-logs-get-access-authentication-logs
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get Access authentication logs response
content:
application/json:
schema:
$ref: '#/components/schemas/access_access-requests_components-schemas-response_collection'
4XX:
description: Get Access authentication logs response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/organizations:
get:
tags:
- Accounts
summary: Cloudflare Get your Zero Trust organization
description: Returns the configuration for your Zero Trust organization.
operationId: zero-trust-organization-get-your-zero-trust-organization
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get your Zero Trust organization response
content:
application/json:
schema:
$ref: '#/components/schemas/access_single_response'
4XX:
description: Get your Zero Trust organization response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create your Zero Trust organization
description: Sets up a Zero Trust organization for your account.
operationId: zero-trust-organization-create-your-zero-trust-organization
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
- auth_domain
properties:
allow_authenticate_via_warp:
$ref: '#/components/schemas/access_allow_authenticate_via_warp'
auth_domain:
$ref: '#/components/schemas/access_auth_domain'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_auto_redirect_to_identity'
is_ui_read_only:
$ref: '#/components/schemas/access_is_ui_read_only'
login_design:
$ref: '#/components/schemas/access_login_design'
name:
$ref: '#/components/schemas/access_name'
session_duration:
$ref: '#/components/schemas/access_session_duration'
ui_read_only_toggle_reason:
$ref: '#/components/schemas/access_ui_read_only_toggle_reason'
user_seat_expiration_inactive_time:
$ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
warp_auth_session_duration:
$ref: '#/components/schemas/access_warp_auth_session_duration'
responses:
'201':
description: Create your Zero Trust organization response
content:
application/json:
schema:
$ref: '#/components/schemas/access_single_response'
4XX:
description: Create your Zero Trust organization response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update your Zero Trust organization
description: Updates the configuration for your Zero Trust organization.
operationId: zero-trust-organization-update-your-zero-trust-organization
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
allow_authenticate_via_warp:
$ref: '#/components/schemas/access_allow_authenticate_via_warp'
auth_domain:
$ref: '#/components/schemas/access_auth_domain'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_auto_redirect_to_identity'
custom_pages:
$ref: '#/components/schemas/access_custom_pages'
is_ui_read_only:
$ref: '#/components/schemas/access_is_ui_read_only'
login_design:
$ref: '#/components/schemas/access_login_design'
name:
$ref: '#/components/schemas/access_name'
session_duration:
$ref: '#/components/schemas/access_session_duration'
ui_read_only_toggle_reason:
$ref: '#/components/schemas/access_ui_read_only_toggle_reason'
user_seat_expiration_inactive_time:
$ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
warp_auth_session_duration:
$ref: '#/components/schemas/access_warp_auth_session_duration'
responses:
'200':
description: Update your Zero Trust organization response
content:
application/json:
schema:
$ref: '#/components/schemas/access_single_response'
4XX:
description: Update your Zero Trust organization response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/organizations/revoke_user:
post:
tags:
- Accounts
summary: Cloudflare Revoke all Access tokens for a user
description: Revokes a user's access across all applications.
operationId: zero-trust-organization-revoke-all-access-tokens-for-a-user
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- email
properties:
email:
type: string
description: The email of the user to revoke.
example: test@example.com
responses:
'200':
description: Revoke all Access tokens for a user response
content:
application/json:
schema:
$ref: '#/components/schemas/access_empty_response'
4xx:
description: Revoke all Access tokens for a user response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/seats:
patch:
tags:
- Accounts
summary: Cloudflare Update a user seat
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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/access_seats_definition'
responses:
'200':
description: Update a user seat response
content:
application/json:
schema:
$ref: '#/components/schemas/access_seats_components-schemas-response_collection'
4XX:
description: Update a user seat response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/service_tokens:
get:
tags:
- Accounts
summary: Cloudflare List service tokens
description: Lists all service tokens.
operationId: access-service-tokens-list-service-tokens
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List service tokens response
content:
application/json:
schema:
$ref: '#/components/schemas/access_components-schemas-response_collection'
4XX:
description: List service tokens response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a service token
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:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
required:
- name
properties:
duration:
$ref: '#/components/schemas/access_duration'
name:
$ref: '#/components/schemas/access_service-tokens_components-schemas-name'
responses:
'201':
description: Create a service token response
content:
application/json:
schema:
$ref: '#/components/schemas/access_create_response'
4XX:
description: Create a service token response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/service_tokens/{uuid}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a service token
description: Deletes a service token.
operationId: access-service-tokens-delete-a-service-token
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Delete a service token response
content:
application/json:
schema:
$ref: '#/components/schemas/access_service-tokens_components-schemas-single_response'
4XX:
description: Delete a service token response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a service token
description: Updates a configured service token.
operationId: access-service-tokens-update-a-service-token
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
required: true
content:
application/json:
schema:
properties:
duration:
$ref: '#/components/schemas/access_duration'
name:
$ref: '#/components/schemas/access_service-tokens_components-schemas-name'
responses:
'200':
description: Update a service token response
content:
application/json:
schema:
$ref: '#/components/schemas/access_service-tokens_components-schemas-single_response'
4XX:
description: Update a service token response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/service_tokens/{uuid}/refresh:
post:
tags:
- Accounts
summary: Cloudflare Refresh a service token
description: Refreshes the expiration of a service token.
operationId: access-service-tokens-refresh-a-service-token
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Refresh a service token response
content:
application/json:
schema:
$ref: '#/components/schemas/access_service-tokens_components-schemas-single_response'
4XX:
description: Refresh a service token response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/service_tokens/{uuid}/rotate:
post:
tags:
- Accounts
summary: Cloudflare Rotate a service token
description: Generates a new Client Secret for a service token and revokes the old one.
operationId: access-service-tokens-rotate-a-service-token
parameters:
- name: uuid
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Rotate a service token response
content:
application/json:
schema:
$ref: '#/components/schemas/access_create_response'
4XX:
description: Rotate a service token response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/tags:
get:
tags:
- Accounts
summary: Cloudflare List tags
description: List tags
operationId: access-tags-list-tags
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: List tags response
content:
application/json:
schema:
$ref: '#/components/schemas/access_tags_components-schemas-response_collection'
4XX:
description: List tags response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
post:
tags:
- Accounts
summary: Cloudflare Create a tag
description: Create a tag
operationId: access-tags-create-tag
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/access_tag_without_app_count'
responses:
'201':
description: Create a tag response
content:
application/json:
schema:
$ref: '#/components/schemas/access_tags_components-schemas-single_response'
4XX:
description: Create a tag response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/tags/{name}:
delete:
tags:
- Accounts
summary: Cloudflare Delete a tag
description: Delete a tag
operationId: access-tags-delete-a-tag
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/access_tags_components-schemas-name'
responses:
'202':
description: Delete a tag response
content:
application/json:
schema:
$ref: '#/components/schemas/access_name_response'
4XX:
description: Delete a tag response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
get:
tags:
- Accounts
summary: Cloudflare Get a tag
description: Get a tag
operationId: access-tags-get-a-tag
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/access_tags_components-schemas-name'
responses:
'200':
description: Get a tag response
content:
application/json:
schema:
$ref: '#/components/schemas/access_tags_components-schemas-single_response'
4XX:
description: Get a tag response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
put:
tags:
- Accounts
summary: Cloudflare Update a tag
description: Update a tag
operationId: access-tags-update-a-tag
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
- name: name
in: path
required: true
schema:
$ref: '#/components/schemas/access_tags_components-schemas-name'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/access_tag_without_app_count'
responses:
'200':
description: Update a tag response
content:
application/json:
schema:
$ref: '#/components/schemas/access_tags_components-schemas-single_response'
4XX:
description: Update a tag response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/users:
get:
tags:
- Accounts
summary: Cloudflare Get users
description: Gets a list of users for an account.
operationId: zero-trust-users-get-users
parameters:
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get users response
content:
application/json:
schema:
$ref: '#/components/schemas/access_users_components-schemas-response_collection'
4XX:
description: Get users response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/users/{id}/active_sessions:
get:
tags:
- Accounts
summary: Cloudflare Get active sessions
description: Get active sessions for a single user.
operationId: zero-trust-users-get-active-sessions
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get active sessions response
content:
application/json:
schema:
$ref: '#/components/schemas/access_active_sessions_response'
4XX:
description: Get active sessions response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/users/{id}/active_sessions/{nonce}:
get:
tags:
- Accounts
summary: Cloudflare Get single active session
description: Get an active session for a single user.
operationId: zero-trust-users-get-active-session
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
- name: nonce
in: path
required: true
schema:
$ref: '#/components/schemas/access_nonce'
responses:
'200':
description: Get active session response
content:
application/json:
schema:
$ref: '#/components/schemas/access_active_session_response'
4XX:
description: Get active session response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/users/{id}/failed_logins:
get:
tags:
- Accounts
summary: Cloudflare Get failed logins
description: Get all failed login attempts for a single user.
operationId: zero-trust-users-get-failed-logins
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get failed logins response
content:
application/json:
schema:
$ref: '#/components/schemas/access_failed_login_response'
4XX:
description: Get failed logins response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts/{identifier}/access/users/{id}/last_seen_identity:
get:
tags:
- Accounts
summary: Cloudflare Get last seen identity
description: Get last seen identity for a single user.
operationId: zero-trust-users-get-last-seen-identity
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/access_uuid'
- name: identifier
in: path
required: true
schema:
$ref: '#/components/schemas/access_identifier'
responses:
'200':
description: Get active session response
content:
application/json:
schema:
$ref: '#/components/schemas/access_last_seen_identity_response'
4XX:
description: Get active session response failure
content:
application/json:
schema:
$ref: '#/components/schemas/access_api-response-common-failure'
security:
- api_email: []
api_key: []
/accounts:
get:
tags:
- Accounts
summary: Cloudflare List Accounts
description: List all accounts you have ownership or verified access to.
operationId: accounts-list-accounts
parameters:
- name: name
in: query
schema:
type: string
description: Name of the account.
example: example.com
readOnly: true
- name: page
in: query
schema:
type: number
description: Page number of paginated results.
default: 1
minimum: 1
- name: per_page
in: query
schema:
type: number
description: Maximum number of results per page.
default: 20
minimum: 5
maximum: 50
- name: direction
in: query
schema:
type: string
description: Direction to order results.
enum:
- asc
- desc
example: desc
responses:
'200':
description: List Accounts response
content:
application/json:
schema:
$ref: '#/components/schemas/iam_response_collection'
4XX:
description: List Accounts response failure
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/iam_response_collection'
- $ref: '#/components/schemas/iam_api-response-common-failure'
security:
- api_email: []
api_key: []
components:
schemas:
d1_sql:
type: string
example: SELECT * FROM myTable WHERE field = ? OR field = ?;
magic_colo_regions:
type: array
description: List of colo regions for the ECMP scope.
items:
$ref: '#/components/schemas/magic_colo_region'
load-balancing_check_regions:
type: array
description: A list of regions from which to run health checks. Null means every Cloudflare data center.
example:
- WEU
- ENAM
nullable: true
items:
type: string
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
bill-subs-api_component_value:
type: object
description: A component value for a subscription.
properties:
default:
type: number
description: The default amount assigned.
example: 5
name:
type: string
description: The name of the component value.
example: page_rules
price:
type: number
description: The unit price for the component value.
example: 5
value:
type: number
description: The amount of the component value assigned.
example: 20
addressing_provisioning:
type: object
description: Status of a Service Binding's deployment to the Cloudflare network
properties:
state:
type: string
description: 'When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service.
'
enum:
- provisioning
- active
example: provisioning
access_ui_read_only_toggle_reason:
type: string
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
dlp_custom_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/dlp_custom_profile'
intel_permissions_update:
properties:
success:
type: boolean
description: Whether the update succeeded or not
rum_site-response-single:
allOf:
- $ref: '#/components/schemas/rum_api-response-single'
- properties:
result:
$ref: '#/components/schemas/rum_site'
logpush_destination_conf:
type: string
format: uri
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
maxLength: 4096
access_domain_rule:
type: object
title: Email domain
description: Match an entire email domain.
required:
- email_domain
properties:
email_domain:
type: object
required:
- domain
properties:
domain:
type: string
description: The email domain to match.
example: example.com
pages_project_name:
type: string
description: Name of the project.
example: this-is-my-project-01
pattern: ^[a-z0-9][a-z0-9-]*$
access_custom_pages:
properties:
forbidden:
type: string
description: The uid of the custom page to use when a user is denied access after failing a non-identity rule.
example: 699d98642c564d2e855e9661899b7252
identity_denied:
type: string
description: The uid of the custom page to use when a user is denied access.
example: 699d98642c564d2e855e9661899b7252
access_saml_saas_app:
type: object
title: SAML SaaS App
properties:
auth_type:
type: string
description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml"
enum:
- saml
- oidc
example: saml
consumer_service_url:
type: string
description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
example: https://example.com
created_at:
$ref: '#/components/schemas/access_timestamp'
custom_attributes:
type: object
properties:
name:
type: string
description: The name of the attribute.
example: family_name
name_format:
type: string
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
source:
type: object
properties:
name:
type: string
description: The name of the IdP attribute.
example: last_name
default_relay_state:
type: string
description: The URL that the user will be redirected to after a successful login for IDP initiated logins.
example: https://example.com
idp_entity_id:
type: string
description: The unique identifier for your SaaS application.
example: https://example.cloudflareaccess.com
name_id_format:
type: string
description: The format of the name identifier sent to the SaaS application.
enum:
- id
- email
example: id
name_id_transform_jsonata:
type: string
description: 'A [JSONata](https://jsonata.org/) expression that transforms an application''s user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.
'
example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@')
public_key:
type: string
description: The Access public certificate that will be used to verify your identity.
example: example unique name
sp_entity_id:
type: string
description: A globally unique name for an identity or service provider.
example: example unique name
sso_endpoint:
type: string
description: The endpoint where your SaaS application will send login requests.
example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd
updated_at:
$ref: '#/components/schemas/access_timestamp'
access_client_secret:
type: string
description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.
example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
rulesets_Ruleset:
type: object
title: Ruleset
description: A ruleset object.
required:
- id
- version
- last_updated
properties:
description:
type: string
title: Description
description: An informative description of the ruleset.
default: ''
example: My ruleset to execute managed rulesets
id:
allOf:
- $ref: '#/components/schemas/rulesets_RulesetId'
- readOnly: true
kind:
$ref: '#/components/schemas/rulesets_RulesetKind'
last_updated:
type: string
title: Last updated
format: date-time
description: The timestamp of when the ruleset was last modified.
example: '2000-01-01T00:00:00.000000Z'
readOnly: true
name:
type: string
title: Name
description: The human-readable name of the ruleset.
example: My ruleset
minLength: 1
phase:
$ref: '#/components/schemas/rulesets_RulesetPhase'
version:
$ref: '#/components/schemas/rulesets_RulesetVersion'
turnstile_offlabel:
type: boolean
description: 'Do not show any Cloudflare branding on the widget (ENT only).
'
example: false
iam_common_components-schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
digital-experience-monitoring_aggregate_time_slot:
type: object
required:
- timestamp
- avgMs
properties:
avgMs:
type: integer
timestamp:
type: string
tunnel_ip_network:
type: string
description: The private IPv4 or IPv6 range connected by the route, in CIDR notation.
example: 172.16.0.0/16
zero-trust-gateway_settings:
type: object
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
public_key:
$ref: '#/components/schemas/zero-trust-gateway_public_key'
seed_id:
$ref: '#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-uuid'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
hyperdrive_api-response-single:
allOf:
- $ref: '#/components/schemas/hyperdrive_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
nullable: true
type: object
registrar-api_telephone:
type: string
description: User's telephone number
example: +1 123-123-1234
nullable: true
maxLength: 20
magic_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
stream_update_input_request:
properties:
defaultCreator:
$ref: '#/components/schemas/stream_live_input_default_creator'
deleteRecordingAfterDays:
$ref: '#/components/schemas/stream_live_input_recording_deletion'
meta:
$ref: '#/components/schemas/stream_live_input_metadata'
recording:
$ref: '#/components/schemas/stream_live_input_recording_settings'
workers_deployment_identifier:
type: string
example: bcf48806-b317-4351-9ee7-36e7d557d4de
readOnly: true
maxLength: 36
workers-kv_namespace_identifier:
type: string
description: Namespace identifier tag.
example: 0f2ac74b498b48028cb68387c421e279
readOnly: true
maxLength: 32
teams-devices_lan_allow_subnet_size:
type: number
description: The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset.
example: 24
magic_lan_dhcp_relay:
type: object
properties:
server_addresses:
type: array
description: List of DHCP server IPs.
items:
$ref: '#/components/schemas/magic_ip-address'
dlp_integration_entry:
type: object
title: Integration entry
description: An entry derived from an integration
properties:
created_at:
$ref: '#/components/schemas/dlp_timestamp'
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
id:
$ref: '#/components/schemas/dlp_entry_id'
name:
type: string
description: The name of the entry.
example: Top Secret
profile_id:
description: ID of the parent profile
updated_at:
$ref: '#/components/schemas/dlp_timestamp'
digital-experience-monitoring_aggregate_time_period:
type: object
required:
- value
- units
properties:
units:
type: string
enum:
- hours
- days
- testRuns
value:
type: integer
zero-trust-gateway_network:
type: object
required:
- network
properties:
network:
type: string
description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.
example: 192.0.2.1/32
teams-devices_allowed_to_leave:
type: boolean
description: Whether to allow devices to leave the organization.
example: true
workers-kv_namespace_title:
type: string
description: A human-readable string name for a Namespace.
example: My Own Namespace
access_any_valid_service_token_rule:
type: object
title: Any Valid Service Token
description: Matches any valid Access Service Token
required:
- any_valid_service_token
properties:
any_valid_service_token:
type: object
description: An empty object which matches on all service tokens.
example: {}
digital-experience-monitoring_fleet_status_devices_response:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/digital-experience-monitoring_device'
magic-transit_mean_rtt_ms:
type: number
description: Mean RTT in ms.
tunnel_teamnet_response_collection:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/tunnel_teamnet'
stream_output_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
$ref: '#/components/schemas/stream_output'
access_active_session_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/access_identity'
- type: object
properties:
isActive:
type: boolean
example: true
type: object
access_schemas-exclude:
type: array
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/access_rule'
secondary-dns_schemas-id_response:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/secondary-dns_schemas-identifier'
access_users_components-schemas-name:
type: string
description: The name of the user.
example: Jane Doe
rum_rule:
type: object
properties:
created:
$ref: '#/components/schemas/rum_timestamp'
host:
type: string
description: The hostname the rule will be applied to.
example: example.com
id:
$ref: '#/components/schemas/rum_rule_identifier'
inclusive:
type: boolean
description: Whether the rule includes or excludes traffic from being measured.
example: true
is_paused:
type: boolean
description: Whether the rule is paused or not.
example: false
paths:
type: array
description: The paths the rule will be applied to.
example:
- '*'
items:
type: string
priority:
type: number
example: 1000
vectorize_update-index-request:
type: object
required:
- description
properties:
description:
$ref: '#/components/schemas/vectorize_index-description'
intel-sinkholes_id:
type: integer
description: The unique identifier for the sinkhole
images_image_thumbnail_url:
type: string
format: uri
description: URI to thumbnail variant for an image.
example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
readOnly: true
tunnel_colo_name:
type: string
description: The Cloudflare data center used for this connection.
example: DFW
workers_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic-visibility_mnm_rules_collection_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-collection'
- properties:
result:
type: array
nullable: true
items:
$ref: '#/components/schemas/magic-visibility_mnm_rule'
lists_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/lists_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/lists_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
d1_account-identifier:
type: string
description: Account identifier tag.
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic-transit_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
magic_schemas-tunnel_add_single_request:
type: object
required:
- name
- cloudflare_endpoint
- interface_address
properties:
cloudflare_endpoint:
$ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
customer_endpoint:
$ref: '#/components/schemas/magic_customer_ipsec_endpoint'
description:
$ref: '#/components/schemas/magic_components-schemas-description'
health_check:
$ref: '#/components/schemas/magic_health_check'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
name:
$ref: '#/components/schemas/magic_schemas-name'
psk:
$ref: '#/components/schemas/magic_psk'
replay_protection:
$ref: '#/components/schemas/magic_replay_protection'
rulesets_Messages:
type: array
title: Messages
description: A list of warning messages.
items:
$ref: '#/components/schemas/rulesets_Message'
magic_wan_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
wan:
$ref: '#/components/schemas/magic_wan'
vectorize_index-delete-vectors-by-id-response:
type: object
properties:
count:
type: integer
description: The count of the vectors successfully deleted.
example: 42
ids:
type: array
description: Array of vector identifiers of the vectors that were successfully processed for deletion.
items:
$ref: '#/components/schemas/vectorize_identifier'
magic-transit_api-response-collection:
allOf:
- $ref: '#/components/schemas/magic-transit_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/magic-transit_result_info'
type: object
stream_end:
type: string
format: date-time
description: Lists videos created before the specified date.
example: '2014-01-02T02:20:00Z'
workers_dispatch_namespace_binding:
type: object
required:
- name
- type
- namespace
properties:
name:
$ref: '#/components/schemas/workers_binding_name'
namespace:
type: string
description: Namespace to bind to
example: my-namespace
outbound:
type: object
description: Outbound worker
properties:
params:
type: array
description: Pass information from the Dispatch Worker to the Outbound Worker through the parameters
items:
type: string
example: url
worker:
type: object
description: Outbound worker
properties:
environment:
type: string
description: Environment of the outbound worker
service:
type: string
description: Name of the outbound worker
type:
type: string
description: The class of resource that the binding provides.
enum:
- dispatch_namespace
example: dispatch_namespace
dns_dns_analytics_api_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
addressing_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_address-maps'
zero-trust-gateway_app-types_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_app-types'
custom-pages_url:
type: string
format: uri
description: The URL associated with the custom page.
default: ''
example: http://www.example.com
stream_thumbnail_url:
type: string
format: uri
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
stream_create_output_request:
required:
- url
- streamKey
properties:
enabled:
$ref: '#/components/schemas/stream_output_enabled'
streamKey:
$ref: '#/components/schemas/stream_output_streamKey'
url:
$ref: '#/components/schemas/stream_output_url'
magic-visibility_mnm_rule:
type: object
nullable: true
required:
- name
- prefixes
- automatic_advertisement
- duration
properties:
automatic_advertisement:
$ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
bandwidth_threshold:
$ref: '#/components/schemas/magic-visibility_mnm_rule_bandwidth_threshold'
duration:
$ref: '#/components/schemas/magic-visibility_mnm_rule_duration'
id:
$ref: '#/components/schemas/magic-visibility_rule_identifier'
name:
$ref: '#/components/schemas/magic-visibility_mnm_rule_name'
packet_threshold:
$ref: '#/components/schemas/magic-visibility_mnm_rule_packet_threshold'
prefixes:
$ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefixes'
aaa_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
aaa_before:
type: string
format: date-time
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'
access_require:
type: array
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/access_rule'
pages_deployment-new-deployment:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
$ref: '#/components/schemas/pages_deployments'
rulesets_RuleRequest:
oneOf:
- $ref: '#/components/schemas/rulesets_BlockRule'
- $ref: '#/components/schemas/rulesets_ExecuteRule'
- $ref: '#/components/schemas/rulesets_LogRule'
- $ref: '#/components/schemas/rulesets_SkipRule'
discriminator:
propertyName: action
mapping:
block: '#/components/schemas/rulesets_BlockRule'
execute: '#/components/schemas/rulesets_ExecuteRule'
log: '#/components/schemas/rulesets_LogRule'
skip: '#/components/schemas/rulesets_SkipRule'
cloudforce-one_request-status:
type: string
title: Request Status
description: Request Status
enum:
- open
- accepted
- reported
- approved
- completed
- declined
addressing_advertised_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
type: object
properties:
advertised:
$ref: '#/components/schemas/addressing_schemas-advertised'
advertised_modified_at:
$ref: '#/components/schemas/addressing_modified_at_nullable'
rum_api-response-single:
allOf:
- $ref: '#/components/schemas/rum_api-response-common'
type: object
addressing_bgp_signaling_enabled:
type: boolean
description: Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal
example: false
aaa_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
registrar-api_registrant_contact:
allOf:
- $ref: '#/components/schemas/registrar-api_contacts'
description: Shows contact information for domain registrant.
magic-visibility_pcaps_id:
type: string
description: The ID for the packet capture.
example: 66802ca5668e47a2b82c2e6746e45037
minLength: 32
maxLength: 32
intel_inherited_content_categories:
$ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
legacy-jhs_cidr_configuration:
title: An IP address range 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:
type: string
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
magic-visibility_pcaps_request_simple:
type: object
required:
- time_limit
- packet_limit
- type
- system
properties:
filter_v1:
$ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
packet_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_packet_limit'
system:
$ref: '#/components/schemas/magic-visibility_pcaps_system'
time_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
type:
$ref: '#/components/schemas/magic-visibility_pcaps_type'
load-balancing_follow_redirects:
type: boolean
description: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
default: false
example: true
magic_description:
type: string
description: An optional human provided description of the static route.
example: New route for new prefix 203.0.113.1
vectorize_index-insert-response:
type: object
properties:
count:
type: integer
description: Specifies the count of the vectors successfully inserted.
example: 768
ids:
type: array
description: Array of vector identifiers of the vectors successfully inserted.
items:
$ref: '#/components/schemas/vectorize_identifier'
teams-devices_gateway_unique_id:
type: string
example: 699d98642c564d2e855e9661899b7252
access_approval_group:
type: object
description: A group of email addresses that can approve a temporary authentication request.
required:
- approvals_needed
properties:
approvals_needed:
type: number
description: The number of approvals needed to obtain access.
example: 1
minimum: 0
email_addresses:
type: array
description: A list of emails that can approve the access request.
example:
- test@cloudflare.com
- test2@cloudflare.com
items: {}
email_list_uuid:
type: string
description: The UUID of an re-usable email list.
tunnel_tunnel-response-single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
anyOf:
- $ref: '#/components/schemas/tunnel_cfd_tunnel'
- $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
access_certificates_components-schemas-name:
type: string
description: The name of the certificate.
example: Allow devs
stream_creator:
type: string
description: A user-defined identifier for the media creator.
example: creator-id_abcde12345
maxLength: 64
access_purpose_justification_required:
type: boolean
description: Require users to enter a justification when they log in to the application.
default: false
example: true
secondary-dns_peer:
type: object
required:
- id
- name
properties:
id:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
ip:
$ref: '#/components/schemas/secondary-dns_ip'
ixfr_enable:
$ref: '#/components/schemas/secondary-dns_ixfr_enable'
name:
$ref: '#/components/schemas/secondary-dns_components-schemas-name'
port:
$ref: '#/components/schemas/secondary-dns_port'
tsig_id:
$ref: '#/components/schemas/secondary-dns_tsig_id'
access_components-schemas-session_duration:
type: string
description: 'The amount of time that tokens issued for the application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.'
default: 24h
example: 24h
turnstile_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/turnstile_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/turnstile_messages'
example: []
result:
type: object
nullable: true
success:
type: boolean
description: Whether the API call was successful
example: false
teams-devices_zero-trust-account-device-settings-response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
type: object
turnstile_region:
type: string
description: Region where this widget can be used.
enum:
- world
default: world
secondary-dns_components-schemas-name:
type: string
description: The name of the peer.
example: my-peer-1
turnstile_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
teams-devices_auto_connect:
type: number
description: The amount of time in minutes to reconnect after having been disabled.
example: 0
lists_operation_id:
type: string
description: The unique operation ID of the asynchronous action.
example: 4da8780eeb215e6cb7f48dd981c4ea02
readOnly: true
zero-trust-gateway_client-default:
type: boolean
description: True if the location is the default location.
example: false
stream_padding:
type: number
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.
default: 0.05
example: 0.1
minimum: 0
maximum: 1
secondary-dns_tsig_id:
type: string
description: TSIG authentication will be used for zone transfer if configured.
example: 69cd1e104af3e6ed3cb344f263fd0d5a
dlp_predefined_entry:
type: object
title: Predefined entry
description: A predefined entry that matches a profile
properties:
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
id:
$ref: '#/components/schemas/dlp_entry_id'
name:
type: string
description: The name of the entry.
example: Credit card (Visa)
profile_id:
description: ID of the parent profile
images_image_upload_via_file:
type: object
title: File
required:
- file
properties:
file:
format: binary
description: An image binary data.
teams-devices_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-managed-networks'
load-balancing_preview_result_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/load-balancing_preview_result'
teams-devices_default:
type: boolean
description: Whether the policy is the default policy for an account.
example: false
load-balancing_enabled:
type: boolean
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).
default: true
example: false
zero-trust-gateway_traffic:
type: string
description: The wirefilter expression used for traffic matching.
example: http.request.uri matches ".*a/partial/uri.*" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10
dns_dns_analytics_api_data:
type: array
description: Array with one row per combination of dimension values.
items:
type: object
required:
- dimensions
properties:
dimensions:
type: array
description: Array of dimension values, representing the combination of dimension values corresponding to this row.
items:
type: string
description: Dimension value.
example: NODATA
iam_components-schemas-member:
type: object
required:
- id
- name
- email
- status
- roles
properties:
email:
$ref: '#/components/schemas/iam_email'
id:
$ref: '#/components/schemas/iam_common_components-schemas-identifier'
name:
$ref: '#/components/schemas/iam_member_components-schemas-name'
roles:
type: array
description: Roles assigned to this Member.
items:
$ref: '#/components/schemas/iam_schemas-role'
status:
description: A member's status in the organization.
enum:
- accepted
- invited
example: accepted
load-balancing_schemas-description:
type: string
description: A human-readable description of the pool.
example: Primary data center - Provider XYZ
magic_components-schemas-name:
type: string
description: The name of the interconnect. The name cannot share a name with other tunnels.
example: pni_ord
magic-visibility_pcaps_ownership_collection:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-collection'
- properties:
result:
type: array
nullable: true
items:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_response'
tunnel_version:
type: string
description: The cloudflared version used to establish this connection.
example: 2022.7.1
zero-trust-gateway_categories_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_categories'
tunnel_empty_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-common'
- type: object
properties:
result:
type: object
addressing_delegated_account_identifier:
type: string
description: Account identifier for the account to which prefix is being delegated.
example: b1946ac92492d2347c6235b4d2611184
maxLength: 32
intel-sinkholes_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/intel-sinkholes_messages'
messages:
$ref: '#/components/schemas/intel-sinkholes_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
workers-kv_result:
type: object
description: Metrics on Workers KV requests.
required:
- rows
- data
- data_lag
- min
- max
- totals
- query
properties:
data:
type: array
nullable: true
items:
type: object
required:
- metrics
properties:
metrics:
type: array
description: List of metrics returned by the query.
items: {}
data_lag:
type: number
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
max:
description: Maximum results for each metric.
min:
description: Minimum results for each metric.
query:
$ref: '#/components/schemas/workers-kv_query'
rows:
type: number
description: Total number of rows in the result.
example: 2
minimum: 0
totals:
description: Total results for metrics across all data.
load-balancing_expected_codes:
type: string
description: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
default: '200'
example: 2xx
addressing_address-maps-membership:
type: object
properties:
can_delete:
$ref: '#/components/schemas/addressing_schemas-can_delete'
created_at:
$ref: '#/components/schemas/addressing_timestamp'
identifier:
$ref: '#/components/schemas/addressing_identifier'
kind:
$ref: '#/components/schemas/addressing_kind'
teams-devices_updated:
type: string
format: date-time
description: When the device was updated.
example: '2017-06-14T00:00:00Z'
addressing_ip_address:
type: string
description: An IPv4 or IPv6 address.
example: 192.0.2.1
magic_colo_names:
type: array
description: List of colo names for the ECMP scope.
items:
$ref: '#/components/schemas/magic_colo_name'
access_name:
type: string
description: The name of your Zero Trust organization.
example: Widget Corps Internal Applications
load-balancing_monitor-response-collection:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/load-balancing_monitor'
access_seats:
type: object
properties:
access_seat:
$ref: '#/components/schemas/access_access_seat'
created_at:
$ref: '#/components/schemas/access_timestamp'
gateway_seat:
$ref: '#/components/schemas/access_gateway_seat'
seat_uid:
$ref: '#/components/schemas/access_identifier'
updated_at:
$ref: '#/components/schemas/access_timestamp'
iam_collection_member_response:
allOf:
- $ref: '#/components/schemas/iam_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/iam_components-schemas-member'
stream_direct_upload_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
properties:
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
uid:
$ref: '#/components/schemas/stream_identifier'
uploadURL:
type: string
description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.
example: www.example.com/samplepath
watermark:
$ref: '#/components/schemas/stream_watermarks'
dlp_DatasetResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_Dataset'
zero-trust-gateway_device_posture:
type: string
description: The wirefilter expression used for device posture check matching.
example: any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"})
stream_live_input_status:
type: string
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
access_okta:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
authorization_server_id:
type: string
description: Your okta authorization server id
example: aus9o8wzkhckw9TLa0h7z
okta_account:
type: string
description: Your okta account url
example: https://dev-abc123.oktapreview.com
type: object
title: Okta
stream_created:
type: string
format: date-time
description: The date and time the media item was created.
example: '2014-01-02T02:20:00Z'
cloudforce-one_uuid:
type: string
description: UUID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
teams-devices_crowdstrike_config_request:
type: object
title: Crowdstrike Config
required:
- api_url
- customer_id
- client_id
- client_secret
properties:
api_url:
type: string
description: The Crowdstrike API URL.
example: https://api.us-2.crowdstrike.com
client_id:
type: string
description: The Crowdstrike client ID.
example: example client id
client_secret:
type: string
description: The Crowdstrike client secret.
example: example client secret
customer_id:
type: string
description: The Crowdstrike customer ID.
example: example customer id
vectorize_api-response-single:
allOf:
- $ref: '#/components/schemas/vectorize_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
nullable: true
type: object
zero-trust-gateway_proxy-endpoints_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
access_create_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
properties:
client_id:
$ref: '#/components/schemas/access_client_id'
client_secret:
$ref: '#/components/schemas/access_client_secret'
created_at:
$ref: '#/components/schemas/access_timestamp'
duration:
$ref: '#/components/schemas/access_duration'
id:
description: The ID of the service token.
name:
$ref: '#/components/schemas/access_service-tokens_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
email_destination_addresses_response_collection:
allOf:
- $ref: '#/components/schemas/email_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/email_addresses'
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 20
total_count:
example: 1
access_skip_interstitial:
type: boolean
description: Enables automatic authentication through cloudflared.
example: true
aaa_single_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
$ref: '#/components/schemas/aaa_policies'
access_warp_props:
allOf:
- $ref: '#/components/schemas/access_feature_app_props'
- properties:
domain:
example: authdomain.cloudflareaccess.com/warp
readOnly: true
name:
default: Warp Login App
example: Warp Login App
readOnly: true
type:
type: string
description: The application type.
example: warp
magic-transit_colo_city:
type: string
description: Source colo city.
example: Denver, CO, US
workers_tag:
type: string
description: Tag to help you manage your Worker
example: my-tag
zero-trust-gateway_app_type_id:
type: integer
description: The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of a returned application type.
addressing_address-maps-ip:
type: object
properties:
created_at:
$ref: '#/components/schemas/addressing_timestamp'
ip:
$ref: '#/components/schemas/addressing_ip'
intel_api-response-single:
allOf:
- $ref: '#/components/schemas/intel_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
dns-firewall_deprecate_any_requests:
type: boolean
description: Deprecate the response to ANY requests.
example: true
magic_schemas-identifier:
type: string
description: Tunnel identifier tag.
example: c4a7362d577a6c3019a474fd6f485821
readOnly: true
maxLength: 32
access_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_groups'
workers_tail-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
expires_at:
readOnly: true
id:
readOnly: true
url:
readOnly: true
images_deleted_response:
allOf:
- $ref: '#/components/schemas/images_api-response-single'
- properties:
result:
type: object
example: {}
stream_video_update:
type: object
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
creator:
$ref: '#/components/schemas/stream_creator'
maxDurationSeconds:
$ref: '#/components/schemas/stream_maxDurationSeconds'
meta:
$ref: '#/components/schemas/stream_media_metadata'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
uploadExpiry:
$ref: '#/components/schemas/stream_oneTimeUploadExpiry'
magic_schemas-tunnel_update_request:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
workers-kv_list_metadata:
type: object
description: Arbitrary JSON that is associated with a key.
example:
someMetadataKey: someMetadataValue
zero-trust-gateway_ip:
type: string
description: IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. This field is auto-generated by Gateway.
example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
access_days_until_next_rotation:
type: number
description: The number of days until the next key rotation.
example: 1
readOnly: true
magic-transit_packets_sent:
type: integer
description: Number of packets sent with specified TTL.
workers-kv_cursor:
type: string
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
stream_downloadedFrom:
type: string
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
bill-subs-api_price:
type: number
description: The price of the subscription that will be billed, in US dollars.
example: 20
readOnly: true
iam_first_name:
type: string
description: User's first name
example: John
nullable: true
maxLength: 60
access_same_site_cookie_attribute:
type: string
description: Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
example: strict
magic-transit_ip:
type: string
description: IP address of the node.
access_access-requests:
type: object
properties:
action:
$ref: '#/components/schemas/access_action'
allowed:
$ref: '#/components/schemas/access_allowed'
app_domain:
$ref: '#/components/schemas/access_app_domain'
app_uid:
$ref: '#/components/schemas/access_app_uid'
connection:
$ref: '#/components/schemas/access_connection'
created_at:
$ref: '#/components/schemas/access_timestamp'
ip_address:
$ref: '#/components/schemas/access_ip'
ray_id:
$ref: '#/components/schemas/access_ray_id'
user_email:
$ref: '#/components/schemas/access_email'
magic_tunnel_add_single_request:
type: object
required:
- name
- customer_gre_endpoint
- cloudflare_gre_endpoint
- interface_address
properties:
cloudflare_gre_endpoint:
$ref: '#/components/schemas/magic_cloudflare_gre_endpoint'
customer_gre_endpoint:
$ref: '#/components/schemas/magic_customer_gre_endpoint'
description:
$ref: '#/components/schemas/magic_schemas-description'
health_check:
$ref: '#/components/schemas/magic_health_check'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
mtu:
$ref: '#/components/schemas/magic_mtu'
name:
$ref: '#/components/schemas/magic_name'
ttl:
$ref: '#/components/schemas/magic_ttl'
hyperdrive_hyperdrive:
type: object
properties:
caching:
$ref: '#/components/schemas/hyperdrive_hyperdrive-caching'
name:
$ref: '#/components/schemas/hyperdrive_hyperdrive-name'
origin:
$ref: '#/components/schemas/hyperdrive_hyperdrive-origin'
addressing_bgp_signal_opts:
type: object
properties:
enabled:
$ref: '#/components/schemas/addressing_bgp_signaling_enabled'
modified_at:
$ref: '#/components/schemas/addressing_bgp_signaling_modified_at'
dlp_predefined_profile:
type: object
title: Predefined profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_predefined_entry'
id:
$ref: '#/components/schemas/dlp_profile_id'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
type:
type: string
description: The type of the profile.
enum:
- predefined
example: predefined
d1_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/d1_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/d1_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic_nexthop:
type: string
description: The next-hop IP Address for the static route.
example: 203.0.113.1
magic-visibility_pcaps_submitted:
type: string
description: The RFC 3339 timestamp when the packet capture was created.
example: '2020-01-01T08:00:00Z'
aaa_created_at:
type: string
format: date-time
description: Timestamp of when the webhook destination was created.
example: '2020-10-26T18:25:04.532316Z'
readOnly: true
intel_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
aaa_audit_logs_response_collection:
oneOf:
- properties:
errors:
type: object
nullable: true
messages:
type: array
example: []
items: {}
result:
type: array
items:
$ref: '#/components/schemas/aaa_audit-logs'
success:
type: boolean
example: true
- $ref: '#/components/schemas/aaa_api-response-common'
zero-trust-gateway_tls-settings:
type: object
description: TLS interception settings.
properties:
enabled:
type: boolean
description: Enable inspecting encrypted HTTP traffic.
example: true
rulesets_UpdateRulesetRequest:
allOf:
- $ref: '#/components/schemas/rulesets_Ruleset'
- required:
- rules
properties:
rules:
$ref: '#/components/schemas/rulesets_RulesRequest'
magic-visibility_account_identifier:
example: 6f91088a406011ed95aed352566e8d4c
tunnel_is_pending_reconnect:
type: boolean
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
aaa_components-schemas-name:
type: string
description: The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
example: Slack Webhook
lists_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/lists_messages'
messages:
$ref: '#/components/schemas/lists_messages'
result:
anyOf:
- type: object
- type: array
items: {}
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_acl_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
acl:
$ref: '#/components/schemas/magic_acl'
calls_account_identifier:
type: string
description: The account identifier tag.
example: 023e105f4ecef8ad9ca31a8372d0c353
maxLength: 32
stream_watermark_basic_upload:
type: object
required:
- file
properties:
file:
type: string
description: The image file to upload.
example: '@/Users/rchen/Downloads/watermark.png'
name:
$ref: '#/components/schemas/stream_name'
opacity:
$ref: '#/components/schemas/stream_opacity'
padding:
$ref: '#/components/schemas/stream_padding'
position:
$ref: '#/components/schemas/stream_position'
scale:
$ref: '#/components/schemas/stream_scale'
zero-trust-gateway_api-response-collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/zero-trust-gateway_result_info'
type: object
dlp_either_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
anyOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
- $ref: '#/components/schemas/dlp_custom_profile'
- $ref: '#/components/schemas/dlp_integration_profile'
d1_query-meta:
type: object
properties:
changed_db:
type: boolean
changes:
type: number
duration:
type: number
last_row_id:
type: number
rows_read:
type: number
rows_written:
type: number
size_after:
type: number
teams-devices_components-schemas-type:
type: string
description: The type of device managed network.
enum:
- tls
example: tls
addressing_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/addressing_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/addressing_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
rum_page:
type: number
description: Current page within the paginated list of results.
example: 1
images_image_variant_height:
type: number
description: Maximum height in image pixels.
example: 768
minimum: 1
registrar-api_domains:
allOf:
- $ref: '#/components/schemas/registrar-api_domain_properties'
type: object
rum_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/rum_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/rum_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
stream_language_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
load-balancing_patch_pools_notification_email:
type: string
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: '""'
access_github_organization_rule:
type: object
title: Github organization
description: 'Matches a Github organization.
Requires a Github identity provider.'
required:
- github-organization
properties:
github-organization:
type: object
required:
- name
- connection_id
properties:
connection_id:
type: string
description: The ID of your Github identity provider.
example: ea85612a-29c8-46c2-bacb-669d65136971
name:
type: string
description: The name of the organization.
example: cloudflare
intel_start_end_params:
type: object
properties:
end:
type: string
format: date
description: Defaults to the current date.
example: '2021-04-30'
start:
type: string
format: date
description: Defaults to 30 days before the end parameter value.
example: '2021-04-01'
logpush_validate_ownership_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
valid:
type: boolean
example: true
secondary-dns_single_response:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-single'
- properties:
result:
$ref: '#/components/schemas/secondary-dns_tsig'
rum_zone_tag:
type: string
description: The zone identifier.
example: 023e105f4ecef8ad9ca31a8372d0c353
access_pingone:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
ping_env_id:
type: string
description: Your PingOne environment identifier
example: 342b5660-0c32-4936-a5a4-ce21fae57b0a
type: object
title: PingOne
iam_two_factor_authentication_enabled:
type: boolean
description: Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.
default: false
readOnly: true
digital-experience-monitoring_colos_response:
type: array
description: array of colos.
items:
type: object
required:
- airportCode
- countryCode
- city
properties:
airportCode:
type: string
description: Airport code
example: SFO
city:
type: string
description: City
example: San Francisco
countryCode:
type: string
description: Country code
example: US
workers_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/workers_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/workers_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
dlp_V4ResponsePagination:
type: object
required:
- page
- per_page
- count
- total_count
properties:
count:
type: integer
format: int32
description: total number of pages
minimum: 0
page:
type: integer
format: int32
description: current page
minimum: 0
per_page:
type: integer
format: int32
description: number of items per page
minimum: 0
total_count:
type: integer
format: int32
description: total number of items
minimum: 0
access_fingerprint:
type: string
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
tunnel_per_page:
type: number
description: Number of results to display.
minimum: 1
rulesets_Response:
type: object
title: Response
description: A response object.
required:
- result
- success
- errors
- messages
properties:
errors:
allOf:
- $ref: '#/components/schemas/rulesets_Errors'
- enum:
- []
messages:
$ref: '#/components/schemas/rulesets_Messages'
result:
title: Result
description: A result.
success:
type: boolean
title: Success
description: Whether the API call was successful.
enum:
- true
access_certificate_rule:
type: object
title: Valid certificate
description: Matches any valid client certificate.
example:
certificate: {}
required:
- certificate
properties:
certificate:
type: object
example: {}
pages_domain-response-collection:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
- properties:
result:
type: array
items:
type: object
rum_order_by:
type: string
description: The property used to sort the list of results.
enum:
- host
- created
example: host
addressing_full_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- type: object
properties:
result:
allOf:
- $ref: '#/components/schemas/addressing_address-maps'
- type: object
properties:
ips:
$ref: '#/components/schemas/addressing_schemas-ips'
memberships:
$ref: '#/components/schemas/addressing_memberships'
images_image_variant_identifier:
example: hero
maxLength: 99
pattern: ^[a-zA-Z0-9]$
calls_app:
type: object
properties:
created:
$ref: '#/components/schemas/calls_created'
modified:
$ref: '#/components/schemas/calls_modified'
name:
$ref: '#/components/schemas/calls_name'
uid:
$ref: '#/components/schemas/calls_identifier'
access_allowed_idps:
type: array
description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.
items:
type: string
description: The identity providers selected for application.
example: 699d98642c564d2e855e9661899b7252
vectorize_create-index-response:
type: object
properties:
config:
$ref: '#/components/schemas/vectorize_index-dimension-configuration'
created_on:
description: Specifies the timestamp the resource was created as an ISO8601 string.
example: '2022-11-15T18:25:44.442097Z'
readOnly: true
description:
$ref: '#/components/schemas/vectorize_index-description'
modified_on:
description: Specifies the timestamp the resource was modified as an ISO8601 string.
example: '2022-11-15T18:25:44.442097Z'
readOnly: true
name:
$ref: '#/components/schemas/vectorize_index-name'
stream_watermarkAtUpload:
type: object
properties:
uid:
type: string
description: The unique identifier for the watermark profile.
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
workers_usage-model-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
usage_model:
readOnly: true
stream_live_input_recording_timeoutSeconds:
type: integer
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.
default: 0
stream_schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
load-balancing_identifier:
type: string
example: f1aba936b94213e5b8dca0c0dbf1f9cc
magic_lan_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
lan:
$ref: '#/components/schemas/magic_lan'
addressing_ipam-bgp-prefixes:
type: object
properties:
asn:
$ref: '#/components/schemas/addressing_asn'
bgp_signal_opts:
$ref: '#/components/schemas/addressing_bgp_signal_opts'
cidr:
$ref: '#/components/schemas/addressing_cidr'
created_at:
$ref: '#/components/schemas/addressing_timestamp'
id:
$ref: '#/components/schemas/addressing_identifier'
modified_at:
$ref: '#/components/schemas/addressing_timestamp'
on_demand:
$ref: '#/components/schemas/addressing_bgp_on_demand'
aaa_last_success:
type: string
format: date-time
description: Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.
example: '2020-10-26T18:25:04.532316Z'
readOnly: true
email_create_destination_address_properties:
type: object
required:
- email
properties:
email:
$ref: '#/components/schemas/email_email'
tls-certificates-and-hostnames_certificateObjectPost:
properties:
ca:
$ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
certificates:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
expires_on:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on'
id:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
issuer:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer'
name:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
serial_number:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number'
signature:
$ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
updated_at:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-updated_at'
uploaded_on:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on'
bill-subs-api_zone:
type: object
description: A simple zone object. May have null properties if not a zone subscription.
properties:
id:
$ref: '#/components/schemas/bill-subs-api_identifier'
name:
$ref: '#/components/schemas/bill-subs-api_name'
workers_placement_mode:
type: string
description: Specifies the placement mode for the Worker (e.g. 'smart').
example: smart
hyperdrive_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/hyperdrive_messages'
messages:
$ref: '#/components/schemas/hyperdrive_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
teams-devices_schemas-id_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
nullable: true
digital-experience-monitoring_test_stat_over_time:
type: object
required:
- slots
properties:
avg:
type: integer
description: average observed in the time period
nullable: true
max:
type: integer
description: highest observed in the time period
nullable: true
min:
type: integer
description: lowest observed in the time period
nullable: true
slots:
type: array
items:
type: object
required:
- timestamp
- value
properties:
timestamp:
type: string
example: 2023-07-16 15:00:00+00:00
value:
type: integer
workers-kv_expiration_ttl:
type: number
description: The number of seconds for which the key should be visible before it expires. At least 60.
example: 300
bill-subs-api_install_id:
type: string
description: app install id.
addressing_description:
type: string
description: Description of the prefix.
example: Internal test prefix
maxLength: 1000
secondary-dns_ip:
type: string
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
digital-experience-monitoring_account_identifier:
type: string
example: 01a7362d577a6c3019a474fd6f485823
readOnly: true
maxLength: 32
magic-transit_std_dev_rtt_ms:
type: number
description: Standard deviation of the RTTs in ms.
stream_name:
type: string
description: A short description of the watermark profile.
default: ''
example: Marketing Videos
registrar-api_zipcode:
type: string
description: The zipcode or postal code where the user lives.
example: '12345'
nullable: true
maxLength: 20
zero-trust-gateway_schemas-uuid:
example: ed35569b41ce4d1facfe683550f54086
zero-trust-gateway_subcategory:
type: object
properties:
beta:
$ref: '#/components/schemas/zero-trust-gateway_beta'
class:
$ref: '#/components/schemas/zero-trust-gateway_class'
description:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
id:
$ref: '#/components/schemas/zero-trust-gateway_id'
name:
$ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
magic_route_delete_many_request:
type: object
required:
- routes
properties:
routes:
type: array
items:
$ref: '#/components/schemas/magic_route_delete_id'
access_schemas-id_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/access_id'
teams-devices_schemas-description:
type: string
description: A description of the policy.
example: Policy for test teams.
maxLength: 500
iam_create:
type: object
required:
- email
- roles
properties:
email:
$ref: '#/components/schemas/iam_email'
roles:
type: array
description: Array of roles associated with this member.
items:
$ref: '#/components/schemas/iam_role_components-schemas-identifier'
status:
enum:
- accepted
- pending
default: pending
security-center_issueType:
type: string
enum:
- compliance_violation
- email_security
- exposed_infrastructure
- insecure_configuration
- weak_authentication
workers_service:
type: string
description: Name of Worker to bind to
example: my-worker
r2_v4_response_list:
allOf:
- $ref: '#/components/schemas/r2_v4_response'
- type: object
properties:
result_info:
$ref: '#/components/schemas/r2_result_info'
tunnel_vnet_name:
type: string
description: A user-friendly name for the virtual network.
example: us-east-1-vpc
addressing_service_name:
type: string
description: Name of a service running on the Cloudflare network
example: Magic Transit
zero-trust-gateway_proxy-endpoints:
type: object
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
id:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
ips:
$ref: '#/components/schemas/zero-trust-gateway_ips'
name:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
subdomain:
$ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
access_app_launcher_props:
allOf:
- $ref: '#/components/schemas/access_feature_app_props'
- properties:
domain:
example: authdomain.cloudflareaccess.com
readOnly: true
name:
default: App Launcher
example: App Launcher
readOnly: true
type:
type: string
description: The application type.
example: app_launcher
iam_components-schemas-name:
type: string
description: Role Name.
example: Organization Admin
readOnly: true
maxLength: 120
access_allow_credentials:
type: boolean
description: When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
workers_environment:
type: string
description: Optional environment if the Worker utilizes one.
example: production
rum_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
registrar-api_domain_response_collection:
allOf:
- $ref: '#/components/schemas/registrar-api_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/registrar-api_domains'
magic_lans_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
lans:
type: array
items:
$ref: '#/components/schemas/magic_lan'
access_feature_app_props:
type: object
required:
- type
properties:
allowed_idps:
$ref: '#/components/schemas/access_allowed_idps'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
domain:
$ref: '#/components/schemas/access_domain'
name:
$ref: '#/components/schemas/access_apps_components-schemas-name'
session_duration:
$ref: '#/components/schemas/access_schemas-session_duration'
type:
$ref: '#/components/schemas/access_type'
stream_start_time_seconds:
type: integer
description: Specifies the start time for the video clip in seconds.
legacy-jhs_schemas-identifier: {}
pages_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/pages_messages'
example:
- code: 7003
message: No route for the URI.
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/pages_messages'
example: []
result:
type: object
nullable: true
success:
type: boolean
description: Whether the API call was successful.
enum:
- false
example: false
zero-trust-gateway_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_rules'
load-balancing_notification_email:
type: string
description: This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. 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
cloudforce-one_priority:
type: string
title: Request Priority
enum:
- routine
- high
- urgent
magic-visibility_pcaps_ownership_validate_request:
type: object
required:
- destination_conf
- ownership_challenge
properties:
destination_conf:
$ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
ownership_challenge:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge'
rum_sites-response-collection:
allOf:
- $ref: '#/components/schemas/rum_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/rum_site'
result_info:
$ref: '#/components/schemas/rum_result_info'
magic-transit_packets_lost:
type: integer
description: Number of packets where no response was received.
d1_database-identifier:
type: string
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
magic-visibility_pcaps_status:
type: string
description: The status of the packet capture request.
enum:
- unknown
- success
- pending
- running
- conversion_pending
- conversion_running
- complete
- failed
example: success
vectorize_index-description:
type: string
description: Specifies the description of the index.
example: This is my example index.
intel_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
pages_deployment_configs:
type: object
description: Configs for deployments in a project.
properties:
preview:
anyOf:
- $ref: '#/components/schemas/pages_deployment_configs_values'
type: object
description: Configs for preview deploys.
production:
anyOf:
- $ref: '#/components/schemas/pages_deployment_configs_values'
type: object
description: Configs for production deploys.
dns-custom-nameservers_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
zero-trust-gateway_custom-certificate-settings:
type: object
description: Custom certificate settings for BYO-PKI.
required:
- enabled
properties:
binding_status:
type: string
description: Certificate status (internal).
example: pending_deployment
readOnly: true
enabled:
type: boolean
description: Enable use of custom certificate authority for signing Gateway traffic.
example: true
id:
type: string
description: UUID of certificate (ID from MTLS certificate store).
example: d1b364c5-1311-466e-a194-f0e943e0799f
updated_at:
type: string
format: date-time
readOnly: true
intel_resolves_to_refs:
type: array
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/intel_resolves_to_ref'
access_empty_response:
allOf:
- properties:
result:
type: boolean
enum:
- true
- false
example: true
success:
type: boolean
enum:
- true
- false
example: true
tunnel_teamnet_response_single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/tunnel_teamnet'
images_image_direct_upload_request_v2:
type: object
properties:
expiry:
type: string
format: date-time
description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.'
default: Now + 30 minutes
example: '2021-01-02T02:20:00Z'
id:
type: string
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
readOnly: true
maxLength: 1024
metadata:
type: object
description: User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.
requireSignedURLs:
type: boolean
description: Indicates whether the image requires a signature token to be accessed.
default: false
example: true
magic-visibility_pcaps_response_full:
type: object
properties:
byte_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_byte_limit'
colo_name:
$ref: '#/components/schemas/magic-visibility_pcaps_colo_name'
destination_conf:
$ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
error_message:
$ref: '#/components/schemas/magic-visibility_pcaps_error_message'
filter_v1:
$ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
id:
$ref: '#/components/schemas/magic-visibility_pcaps_id'
status:
$ref: '#/components/schemas/magic-visibility_pcaps_status'
submitted:
$ref: '#/components/schemas/magic-visibility_pcaps_submitted'
system:
$ref: '#/components/schemas/magic-visibility_pcaps_system'
time_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
type:
$ref: '#/components/schemas/magic-visibility_pcaps_type'
dns-firewall_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
workers_bindings:
type: array
description: List of bindings attached to this Worker
items:
$ref: '#/components/schemas/workers_binding'
logpush_logpush_job_response_collection:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/logpush_logpush_job'
magic-visibility_pcaps_destination_conf:
type: string
description: The full URI for the bucket. This field only applies to `full` packet captures.
example: s3://pcaps-bucket?region=us-east-1
magic-transit_packet_count:
type: integer
description: Number of packets with a response from this node.
stream_watermark_identifier:
type: string
description: The unique identifier for a watermark profile.
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
teams-devices_schemas-name:
type: string
description: The device name.
example: My mobile device
load-balancing_load_shedding:
type: object
description: Configures load shedding policies and percentages for the pool.
properties:
default_percent:
type: number
description: The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
default: 0
minimum: 0
maximum: 100
default_policy:
type: string
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
default: random
session_percent:
type: number
description: The percent of existing sessions to shed from the pool, according to the session policy.
default: 0
minimum: 0
maximum: 100
session_policy:
type: string
description: Only the hash policy is supported for existing sessions (to avoid exponential decay).
enum:
- hash
default: hash
images_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/images_messages'
messages:
$ref: '#/components/schemas/images_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
stream_playback_rtmps_stream_key:
type: string
description: The secret key to use for playback via RTMPS.
example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
magic_site_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
site:
$ref: '#/components/schemas/magic_site'
rulesets_CreateRulesetRequest:
allOf:
- $ref: '#/components/schemas/rulesets_Ruleset'
- required:
- name
- kind
- phase
- rules
properties:
rules:
$ref: '#/components/schemas/rulesets_RulesRequest'
access_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_service-tokens'
zero-trust-gateway_items:
type: array
description: The items in the list.
items:
type: object
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
value:
$ref: '#/components/schemas/zero-trust-gateway_value'
addressing_api-response-single:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
aaa_per_page:
type: number
description: Number of items per page.
default: 25
minimum: 5
maximum: 1000
zero-trust-gateway_components-schemas-uuid:
type: string
description: The API resource UUID.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
vectorize_index-configuration:
oneOf:
- $ref: '#/components/schemas/vectorize_index-preset-configuration'
- $ref: '#/components/schemas/vectorize_index-dimension-configuration'
description: Specifies the type of configuration to use for the index.
iam_api-response-single:
allOf:
- $ref: '#/components/schemas/iam_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
stream_playback_srt_stream_id:
type: string
description: The identifier of the live input to use for playback via SRT.
example: f256e6ea9341d51eea64c9454659e576
access_string_key_map_device_session:
type: object
stream_create_input_request:
properties:
defaultCreator:
$ref: '#/components/schemas/stream_live_input_default_creator'
deleteRecordingAfterDays:
$ref: '#/components/schemas/stream_live_input_recording_deletion'
meta:
$ref: '#/components/schemas/stream_live_input_metadata'
recording:
$ref: '#/components/schemas/stream_live_input_recording_settings'
rum_result_info:
type: object
properties:
count:
type: integer
description: The total number of items on the current page.
example: 10
page:
type: integer
description: Current page within the paginated list of results.
example: 1
per_page:
type: integer
description: The maximum number of items to return per page of results.
example: 10
total_count:
type: integer
description: The total number of items.
example: 25
total_pages:
type: integer
description: The total number of pages.
example: 3
nullable: true
teams-devices_lan_allow_minutes:
type: number
description: The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a laptop waking from sleep. Note that this field is omitted from the response if null or unset.
example: 30
addressing_service_binding:
type: object
properties:
cidr:
$ref: '#/components/schemas/addressing_cidr'
id:
$ref: '#/components/schemas/addressing_identifier'
provisioning:
$ref: '#/components/schemas/addressing_provisioning'
service_id:
$ref: '#/components/schemas/addressing_service_identifier'
service_name:
$ref: '#/components/schemas/addressing_service_name'
images_image_filename:
type: string
description: Image file name.
example: logo.png
readOnly: true
maxLength: 32
intel-sinkholes_get_sinkholes_response:
allOf:
- $ref: '#/components/schemas/intel-sinkholes_api-response-common'
- properties:
result:
type: array
example:
- account_tag: 233f45e61fd1f7e21e1e154ede4q2859
created_on: '2023-05-12T12:21:56.777653Z'
description: user specified description 1
id: 1
modified_on: '2023-06-18T03:13:34.123321Z'
name: sinkhole_1
r2_bucket: my_bucket
r2_id:
- account_tag: 233f45e61fd1f7e21e1e154ede4q2859
created_on: '2023-05-21T21:43:52.867525Z'
description: user specified description 2
id: 2
modified_on: '2023-06-28T18:46:18.764425Z'
name: sinkhole_1
r2_bucket: my_bucket
r2_id:
items:
$ref: '#/components/schemas/intel-sinkholes_sinkhole_item'
legacy-jhs_egs-pagination:
type: object
properties:
page:
type: number
description: The page number of paginated results.
default: 1
minimum: 1
per_page:
type: number
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`.
default: 20
minimum: 1
maximum: 1000
dns-firewall_upstream_ips:
type: array
example:
- 192.0.2.1
- 198.51.100.1
- 2001:DB8:100::CF
items:
anyOf:
- type: string
format: ipv4
description: Upstream DNS Server IPv4 Address.
example: 192.0.2.1
- type: string
format: ipv6
description: Upstream DNS Server IPv6 Address.
example: 2001:DB8:100::CF
intel_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_allowedOrigins:
type: array
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
load-balancing_preview_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
properties:
pools:
type: object
description: Monitored pool IDs mapped to their respective names.
example:
abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter
ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter
preview_id:
$ref: '#/components/schemas/load-balancing_identifier'
stream_listAudioTrackResponse:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_additionalAudio'
lists_modified_on:
type: string
description: The RFC 3339 timestamp of when the list was last modified.
example: '2020-01-10T14:00:00Z'
dns-firewall_ecs_fallback:
type: boolean
description: Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.
example: false
images_image_variant_list_response:
allOf:
- $ref: '#/components/schemas/images_api-response-common'
- properties:
result:
$ref: '#/components/schemas/images_image_variants_response'
dns-custom-nameservers_acns_response_single:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
aaa_policy-id:
type: string
description: The unique identifier of a notification policy
example: 0da2b59e-f118-439d-8097-bdfb215203c9
readOnly: true
maxLength: 36
digital-experience-monitoring_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
workers_single_step_migrations:
allOf:
- $ref: '#/components/schemas/workers_migration_tag_conditions'
- $ref: '#/components/schemas/workers_migration_step'
description: A single set of migrations to apply.
dns_dns_analytics_api_dimensions:
type: string
description: A comma-separated list of dimensions to group results by.
example: queryType
magic-transit_options:
example:
max_ttl: 15
packet_type: icmp
properties:
max_ttl:
$ref: '#/components/schemas/magic-transit_max_ttl'
packet_type:
$ref: '#/components/schemas/magic-transit_packet_type'
packets_per_ttl:
$ref: '#/components/schemas/magic-transit_packets_per_ttl'
port:
$ref: '#/components/schemas/magic-transit_port'
wait_time:
$ref: '#/components/schemas/magic-transit_wait_time'
legacy-jhs_api-response-single-id:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-common'
- properties:
result:
type: object
nullable: true
required:
- id
properties:
id:
$ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
type: object
zero-trust-gateway_gateway-account-logging-settings-response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
type: object
load-balancing_consecutive_up:
type: integer
description: To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
default: 0
access_basic_app_response_props:
type: object
properties:
aud:
$ref: '#/components/schemas/access_schemas-aud'
created_at:
$ref: '#/components/schemas/access_timestamp'
id:
$ref: '#/components/schemas/access_uuid'
updated_at:
$ref: '#/components/schemas/access_timestamp'
hyperdrive_hyperdrive-origin:
type: object
required:
- host
- port
- scheme
- database
- user
properties:
database:
type: string
description: The name of your origin database.
example: postgres
host:
type: string
description: The host (hostname or IP) of your origin database.
example: database.example.com
port:
type: integer
description: 'The port (default: 5432 for Postgres) of your origin database.'
example: '5432'
scheme:
$ref: '#/components/schemas/hyperdrive_hyperdrive-scheme'
user:
type: string
description: The user of your origin database.
example: postgres
rulesets_BlockRule:
allOf:
- $ref: '#/components/schemas/rulesets_Rule'
- title: Block rule
properties:
action:
enum:
- block
action_parameters:
properties:
response:
type: object
title: Response
description: The response to show when the block is applied.
required:
- status_code
- content
- content_type
properties:
content:
type: string
title: Content
description: The content to return.
example: "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}"
minLength: 1
content_type:
type: string
title: Content type
description: The type of the content to return.
example: application/json
minLength: 1
status_code:
type: integer
title: Status code
description: The status code to return.
minimum: 400
maximum: 499
description:
example: Block when the IP address is not 1.1.1.1
magic_ttl:
type: integer
description: Time To Live (TTL) in number of hops of the GRE tunnel.
default: 64
access_nonce:
type: string
example: X1aXj1lFVcqqyoXF
dns-custom-nameservers_availability_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
items:
type: string
format: hostname
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
readOnly: true
magic-visibility_pcaps_collection_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-collection'
- properties:
result:
type: array
items:
anyOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_response_simple'
- $ref: '#/components/schemas/magic-visibility_pcaps_response_full'
magic_ipsec-tunnel:
type: object
required:
- name
- cloudflare_endpoint
- interface_address
properties:
allow_null_cipher:
$ref: '#/components/schemas/magic_allow_null_cipher'
cloudflare_endpoint:
$ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
created_on:
$ref: '#/components/schemas/magic_schemas-created_on'
customer_endpoint:
$ref: '#/components/schemas/magic_customer_ipsec_endpoint'
description:
$ref: '#/components/schemas/magic_components-schemas-description'
id:
$ref: '#/components/schemas/magic_schemas-identifier'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
modified_on:
$ref: '#/components/schemas/magic_schemas-modified_on'
name:
$ref: '#/components/schemas/magic_schemas-name'
psk_metadata:
$ref: '#/components/schemas/magic_psk_metadata'
replay_protection:
$ref: '#/components/schemas/magic_replay_protection'
tunnel_health_check:
$ref: '#/components/schemas/magic_tunnel_health_check'
addressing_schemas-advertised:
type: boolean
description: Enablement of prefix advertisement to the Internet.
example: true
load-balancing_method:
type: string
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.
default: GET
example: GET
magic-visibility_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
calls_modified:
type: string
format: date-time
description: The date and time the item was last modified.
example: '2014-01-02T02:20:00Z'
access_seat_uid:
description: The unique API identifier for the Zero Trust seat.
tunnel_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/tunnel_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/tunnel_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
intel_phishing-url-submit:
properties:
excluded_urls:
type: array
description: URLs that were excluded from scanning because their domain is in our no-scan list.
items:
type: object
properties:
url:
type: string
description: URL that was excluded.
example: https://developers.cloudflare.com
skipped_urls:
type: array
description: URLs that were skipped because the same URL is currently being scanned
items:
type: object
properties:
url:
type: string
description: URL that was skipped.
example: https://www.cloudflare.com/developer-week/
url_id:
type: integer
description: ID of the submission of that URL that is currently scanning.
example: 2
submitted_urls:
type: array
description: URLs that were successfully submitted for scanning.
items:
type: object
properties:
url:
type: string
description: URL that was submitted.
example: https://www.cloudflare.com
url_id:
type: integer
description: ID assigned to this URL submission. Used to retrieve scanning results.
example: 1
images_image_variant_neverRequireSignedURLs:
type: boolean
description: Indicates whether the variant can access an image without a signature, regardless of image access control.
default: false
example: true
access_custom_deny_message:
type: string
description: The custom error message shown to a user when they are denied access to the application.
magic_site_update_request:
type: object
properties:
site:
type: object
properties:
connector_id:
$ref: '#/components/schemas/magic_connector-id'
description:
type: string
location:
$ref: '#/components/schemas/magic_site-location'
name:
$ref: '#/components/schemas/magic_site-name'
secondary_connector_id:
$ref: '#/components/schemas/magic_secondary-connector-id'
tunnel_conns_active_at:
type: string
format: date-time
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'
nullable: true
access_ca_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
turnstile_created_on:
type: string
format: date-time
description: When the widget was created.
example: '2014-01-01T05:20:00.123123Z'
readOnly: true
dns_dns_analytics_api_report:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_result'
- required:
- data
properties:
data:
items:
required:
- metrics
properties:
metrics:
type: array
description: Array with one item per requested metric. Each item is a single value.
items:
type: number
description: Nominal metric value.
access_failed_login_response:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
type: object
properties:
expiration:
type: integer
metadata:
type: object
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
magic_cidr:
type: string
description: A valid CIDR notation representing an IP range.
example: 192.0.2.0/24
tunnel_vnet_response_single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: object
registrar-api_last_name:
type: string
description: User's last name
example: Appleseed
nullable: true
maxLength: 60
access_tag:
type: object
description: A tag
required:
- name
properties:
app_count:
type: integer
description: The number of applications that have this tag
example: 1
created_at:
$ref: '#/components/schemas/access_timestamp'
name:
$ref: '#/components/schemas/access_tags_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
intel_feed_id:
type: integer
description: Indicator feed ID
example: 12
tunnel_is_default_network:
type: boolean
description: If `true`, this virtual network is the default for the account.
example: true
tunnel_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/tunnel_messages'
messages:
$ref: '#/components/schemas/tunnel_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
rulesets_RulesRequest:
type: array
title: Rules
description: The list of rules in the ruleset.
items:
$ref: '#/components/schemas/rulesets_RuleRequest'
dns-firewall_name:
type: string
description: DNS Firewall Cluster Name.
example: My Awesome DNS Firewall cluster
maxLength: 160
calls_app_response_single:
allOf:
- $ref: '#/components/schemas/calls_api-response-single'
- properties:
result:
$ref: '#/components/schemas/calls_app'
access_custom_deny_url:
type: string
description: The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules.
hyperdrive_hyperdrive-origin-with-password:
allOf:
- $ref: '#/components/schemas/hyperdrive_hyperdrive-origin'
type: object
required:
- password
properties:
password:
type: string
description: The password required to access your origin database. This value is write-only and never returned by the API.
example: password1234!
magic_components-schemas-description:
type: string
description: An optional description forthe IPsec tunnel.
example: Tunnel for ISP X
bill-subs-api_schemas-identifier:
type: string
description: Subscription identifier tag.
example: 506e3185e9c882d175a2d0cb0093d9f2
readOnly: true
maxLength: 32
stream_live_input_recording_deletion:
type: number
description: Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion.
example: 45
minimum: 30
access_schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_identity-providers'
access_custom-pages_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_custom_page_without_html'
dns-firewall_schemas-dns-firewall:
allOf:
- $ref: '#/components/schemas/dns-firewall_dns-firewall'
type: object
images_image_original_url:
type: string
format: uri
description: URI to original variant for an image.
example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
readOnly: true
workers_pipeline_hash:
type: string
description: Deprecated. Deployment metadata for internal usage.
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
email_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/email_messages'
messages:
$ref: '#/components/schemas/email_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_health_check:
type: object
properties:
direction:
type: string
description: The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel. Note in the case of bidirecitonal healthchecks, the target field in health_check is ignored as the interface_address is used to send traffic into the tunnel.
enum:
- unidirectional
- bidirectional
default: unidirectional
example: bidirectional
enabled:
type: boolean
description: Determines whether to run healthchecks for a tunnel.
default: true
example: true
rate:
type: string
description: How frequent the health check is run. The default value is `mid`.
enum:
- low
- mid
- high
default: mid
example: low
target:
type: string
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`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
example: 203.0.113.1
type:
type: string
description: The type of healthcheck to run, reply or request. The default value is `reply`.
enum:
- reply
- request
default: reply
example: request
dlp_shared_entry_update_predefined:
type: object
title: Update predefined entry
description: Properties of a predefined entry in a custom profile
properties:
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
entry_id:
$ref: '#/components/schemas/dlp_entry_id'
r2_enable_sippy_aws:
properties:
destination:
type: object
description: R2 bucket to copy objects to
properties:
accessKeyId:
type: string
description: 'ID of a Cloudflare API token.
This is the value labelled "Access Key ID" when creating an API
token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
Sippy will use this token when writing objects to R2, so it is
best to scope this token to the bucket you''re enabling Sippy for.
'
provider:
type: string
enum:
- r2
secretAccessKey:
type: string
description: 'Value of a Cloudflare API token.
This is the value labelled "Secret Access Key" when creating an API
token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
Sippy will use this token when writing objects to R2, so it is
best to scope this token to the bucket you''re enabling Sippy for.
'
source:
type: object
description: AWS S3 bucket to copy objects from
properties:
accessKeyId:
type: string
description: Access Key ID of an IAM credential (ideally scoped to a single S3 bucket)
bucket:
type: string
description: Name of the AWS S3 bucket
provider:
type: string
enum:
- aws
region:
type: string
description: Name of the AWS availability zone
secretAccessKey:
type: string
description: Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket)
images_image_patch_request:
type: object
properties:
metadata:
type: object
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.
requireSignedURLs:
type: boolean
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
teams-devices_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/teams-devices_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/teams-devices_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
email_modified:
type: string
format: date-time
description: The date and time the destination address was last modified.
example: '2014-01-02T02:20:00Z'
readOnly: true
addressing_ipam-prefixes:
type: object
properties:
account_id:
$ref: '#/components/schemas/addressing_identifier'
advertised:
$ref: '#/components/schemas/addressing_advertised'
advertised_modified_at:
$ref: '#/components/schemas/addressing_modified_at_nullable'
approved:
$ref: '#/components/schemas/addressing_approved'
asn:
$ref: '#/components/schemas/addressing_asn'
cidr:
$ref: '#/components/schemas/addressing_cidr'
created_at:
$ref: '#/components/schemas/addressing_timestamp'
description:
$ref: '#/components/schemas/addressing_description'
id:
$ref: '#/components/schemas/addressing_identifier'
loa_document_id:
$ref: '#/components/schemas/addressing_loa_document_identifier'
modified_at:
$ref: '#/components/schemas/addressing_timestamp'
on_demand_enabled:
$ref: '#/components/schemas/addressing_on_demand_enabled'
on_demand_locked:
$ref: '#/components/schemas/addressing_on_demand_locked'
stream_live_input_created:
type: string
format: date-time
description: The date and time the live input was created.
example: '2014-01-02T02:20:00Z'
workers_queue:
type: object
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/workers_name'
load-balancing_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/load-balancing_pool'
intel_additional_information:
type: object
description: Additional information related to the host name.
properties:
suspected_malware_family:
type: string
description: Suspected DGA malware family.
example: ''
access_service_auth_401_redirect:
type: boolean
description: Returns a 401 status code when the request is blocked by a Service Auth policy.
example: true
request-tracer_trace:
type: array
items:
type: object
description: List of steps acting on request/response
properties:
action:
type: string
description: If step type is rule, then action performed by this rule
example: execute
pattern: ^[a-z_]+$
action_parameters:
type: object
description: If step type is rule, then action parameters of this rule as JSON
example:
id: 4814384a9e5d4991b9815dcfc25d2f1f
description:
type: string
description: If step type is rule or ruleset, the description of this entity
example: some rule
expression:
type: string
description: If step type is rule, then expression used to match for this rule
example: ip.src ne 1.1.1.1
kind:
type: string
description: If step type is ruleset, then kind of this ruleset
example: zone
matched:
type: boolean
description: Whether tracing step affected tracing request/response
example: true
name:
type: string
description: If step type is ruleset, then name of this ruleset
example: some ruleset name
step_name:
type: string
description: Tracing step identifying name
example: rule_id01
trace:
$ref: '#/components/schemas/request-tracer_trace'
type:
type: string
description: Tracing step type
example: rule
teams-devices_components-schemas-name:
type: string
description: The name of the device posture integration.
example: My Workspace One Integration
workers_account_identifier:
example: 9a7806061c88ada191ed06f989cc3dac
access_allow_all_origins:
type: boolean
description: Allows all origins.
intel_ip-list:
properties:
description:
type: string
id:
type: integer
name:
type: string
example: Malware
magic_route_delete_id:
allOf:
- required:
- id
properties:
id:
$ref: '#/components/schemas/magic_identifier'
aaa_schemas-single_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
$ref: '#/components/schemas/aaa_webhooks'
iam_member_with_code:
allOf:
- $ref: '#/components/schemas/iam_member'
- type: object
properties:
code:
$ref: '#/components/schemas/iam_code'
logpush_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/logpush_messages'
messages:
$ref: '#/components/schemas/logpush_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
gre_tunnels:
type: array
items:
$ref: '#/components/schemas/magic_gre-tunnel'
tls-certificates-and-hostnames_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
dlp_SkipConfig:
type: object
description: Content types to exclude from context analysis and return all matches.
required:
- files
properties:
files:
type: boolean
description: If the content type is a file, skip context analysis and return all matches.
rulesets_RulesetsResponse:
type: array
title: Rulesets
description: A list of rulesets. The returned information will not include the rules in each ruleset.
items:
allOf:
- $ref: '#/components/schemas/rulesets_Ruleset'
- required:
- name
- kind
- phase
registrar-api_domain_identifier:
type: string
description: Domain identifier.
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
maxLength: 32
magic-transit_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/magic-transit_messages'
messages:
$ref: '#/components/schemas/magic-transit_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
rulesets_RuleEnabled:
type: boolean
title: Enabled
description: Whether the rule should be executed.
example: true
zero-trust-gateway_gateway-account-settings:
type: object
description: account settings.
properties:
settings:
type: object
description: account settings.
properties:
activity_log:
$ref: '#/components/schemas/zero-trust-gateway_activity-log-settings'
antivirus:
$ref: '#/components/schemas/zero-trust-gateway_anti-virus-settings'
block_page:
$ref: '#/components/schemas/zero-trust-gateway_block-page-settings'
body_scanning:
$ref: '#/components/schemas/zero-trust-gateway_body-scanning-settings'
browser_isolation:
$ref: '#/components/schemas/zero-trust-gateway_browser-isolation-settings'
custom_certificate:
$ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
extended_email_matching:
$ref: '#/components/schemas/zero-trust-gateway_extended-email-matching'
fips:
$ref: '#/components/schemas/zero-trust-gateway_fips-settings'
protocol_detection:
$ref: '#/components/schemas/zero-trust-gateway_protocol-detection'
tls_decrypt:
$ref: '#/components/schemas/zero-trust-gateway_tls-settings'
logpush_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
zero-trust-gateway_identity:
type: string
description: The wirefilter expression used for identity matching.
example: any(identity.groups.name[*] in {"finance"})
access_seats_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_seats'
logcontrol_cmb_config_response_single:
allOf:
- $ref: '#/components/schemas/logcontrol_api-response-single'
- properties:
result:
$ref: '#/components/schemas/logcontrol_cmb_config'
intel_indicator_feed_metadata:
example:
created_on: '2023-05-12T12:21:56.777653Z'
description: example feed description
id: 1
latest_upload_status: Complete
modified_on: '2023-06-18T03:13:34.123321Z'
name: example_feed_1
properties:
created_on:
type: string
format: date-time
description: The date and time when the data entry was created
description:
$ref: '#/components/schemas/intel_description'
id:
$ref: '#/components/schemas/intel_id'
latest_upload_status:
type: string
description: Status of the latest snapshot uploaded
enum:
- Mirroring
- Unifying
- Loading
- Provisioning
- Complete
- Error
modified_on:
type: string
format: date-time
description: The date and time when the data entry was last modified
name:
$ref: '#/components/schemas/intel_name'
magic-visibility_mnm_rule_name:
type: string
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
bill-subs-api_subscription:
allOf:
- $ref: '#/components/schemas/bill-subs-api_subscription-v2'
type: object
dlp_uuid:
type: string
description: UUID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
load-balancing_retries:
type: integer
description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
default: 2
magic_acl:
type: object
description: Bidirectional ACL policy for local network traffic within a site.
properties:
description:
type: string
description: Description for the ACL.
example: Allows local traffic between PIN pads and cash register.
id:
$ref: '#/components/schemas/magic_identifier'
lan_1:
$ref: '#/components/schemas/magic_lan-acl-configuration'
lan_2:
$ref: '#/components/schemas/magic_lan-acl-configuration'
name:
type: string
description: The name of the ACL.
example: PIN Pad - Cash Register
protocols:
type: array
items:
type: string
description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
enum:
- tcp
- udp
- icmp
tunnel_vnet_response_collection:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/tunnel_virtual-network'
load-balancing_schemas-header:
type: object
description: The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
properties:
Host:
$ref: '#/components/schemas/load-balancing_Host'
magic_routed_subnet:
type: object
required:
- prefix
- next_hop
properties:
nat:
$ref: '#/components/schemas/magic_nat'
next_hop:
$ref: '#/components/schemas/magic_ip-address'
prefix:
$ref: '#/components/schemas/magic_cidr'
dlp_update_custom_profile:
type: object
title: Update custom profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
description:
type: string
description: The description of the profile.
example: A standard CVV card number
entries:
type: array
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/dlp_custom_entry'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
shared_entries:
type: array
description: Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).
items:
oneOf:
- $ref: '#/components/schemas/dlp_shared_entry_update_predefined'
- $ref: '#/components/schemas/dlp_shared_entry_update_integration'
tls-certificates-and-hostnames_api-response-single:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
pages_deployment-list-response:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
- properties:
result:
type: array
items:
$ref: '#/components/schemas/pages_deployments'
intel_phishing-url-info_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_phishing-url-info'
teams-devices_model:
type: string
description: The device model name.
example: MyPhone(pro-X)
rum_auto_install:
type: boolean
description: If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
example: true
load-balancing_region_code:
type: string
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
bill-subs-api_current_period_start:
type: string
format: date-time
description: When the current billing period started. May match initial_period_start if this is the first period.
example: '2014-05-11T12:20:00Z'
readOnly: true
teams-devices_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-posture-rules'
magic_schemas-tunnel_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_ipsec_tunnel:
type: object
lists_list-delete-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/lists_item_id'
type: object
zero-trust-gateway_gateway_account:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
type: object
properties:
gateway_tag:
$ref: '#/components/schemas/zero-trust-gateway_gateway_tag'
id:
$ref: '#/components/schemas/zero-trust-gateway_cf_account_id'
provider_name:
$ref: '#/components/schemas/zero-trust-gateway_provider_name'
type: object
rum_site_tag:
type: string
description: The Web Analytics site identifier.
example: 023e105f4ecef8ad9ca31a8372d0c353
magic_schemas-health_check:
type: object
properties:
enabled:
type: boolean
description: Determines whether to run healthchecks for a tunnel.
default: true
example: true
rate:
type: string
description: How frequent the health check is run. The default value is `mid`.
enum:
- low
- mid
- high
default: mid
example: low
target:
type: string
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:
type: string
description: The type of healthcheck to run, reply or request. The default value is `reply`.
enum:
- reply
- request
default: reply
example: request
magic-visibility_api-response-single:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
access_authentication_method_rule:
type: object
title: Authentication method
description: Enforce different MFA options
required:
- auth_method
properties:
auth_method:
type: object
required:
- auth_method
properties:
auth_method:
type: string
description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
example: mfa
d1_database-details-response:
type: object
properties:
created_at:
description: Specifies the timestamp the resource was created as an ISO8601 string.
example: '2022-11-15T18:25:44.442097Z'
readOnly: true
file_size:
$ref: '#/components/schemas/d1_file-size'
name:
$ref: '#/components/schemas/d1_database-name'
num_tables:
$ref: '#/components/schemas/d1_table-count'
uuid:
$ref: '#/components/schemas/d1_database-identifier'
version:
$ref: '#/components/schemas/d1_database-version'
email_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
access_bookmark_props:
type: object
title: Bookmark application
properties:
app_launcher_visible:
default: true
domain:
description: The URL or domain of the bookmark.
example: https://mybookmark.com
logo_url:
$ref: '#/components/schemas/access_logo_url'
name:
$ref: '#/components/schemas/access_apps_components-schemas-name'
tags:
$ref: '#/components/schemas/access_tags'
type:
type: string
description: The application type.
example: bookmark
load-balancing_header:
type: object
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
dlp_NewDataset:
type: object
required:
- name
properties:
description:
type: string
nullable: true
name:
type: string
secret:
type: boolean
description: 'Generate a secret dataset.
If true, the response will include a secret to use with the EDM encoder.
If false, the response has no secret and the dataset is uploaded in plaintext.'
workers_namespace-script-response-single:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
$ref: '#/components/schemas/workers_namespace-script-response'
custom-pages_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/custom-pages_messages'
messages:
$ref: '#/components/schemas/custom-pages_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic-visibility_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/magic-visibility_messages'
messages:
$ref: '#/components/schemas/magic-visibility_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
zero-trust-gateway_protocol-detection:
type: object
description: Protocol Detection settings.
properties:
enabled:
type: boolean
description: Enable detecting protocol on initial bytes of client traffic.
example: true
bill-subs-api_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/bill-subs-api_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/bill-subs-api_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic-transit_targets:
type: array
example:
- 203.0.113.1
- cloudflare.com
maxLength: 10
items:
type: string
description: Hosts as a hostname or IPv4/IPv6 address represented by strings.
example: 203.0.113.1
d1_table-count:
type: number
example: 12
magic_route_update_single_request:
allOf:
- required:
- id
properties:
id:
$ref: '#/components/schemas/magic_identifier'
- $ref: '#/components/schemas/magic_route_add_single_request'
images_image_basic_upload:
oneOf:
- $ref: '#/components/schemas/images_image_upload_via_file'
- $ref: '#/components/schemas/images_image_upload_via_url'
type: object
properties:
metadata:
type: object
description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
requireSignedURLs:
type: boolean
description: Indicates whether the image requires a signature token for the access.
default: false
example: true
zero-trust-gateway_deleted_at:
type: string
format: date-time
description: Date of deletion, if any.
nullable: true
readOnly: true
d1_file-size:
type: number
description: The D1 database's size, in bytes.
example: 12
logpush_output_options:
type: object
description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.
nullable: true
properties:
CVE-2021-4428:
type: boolean
description: If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.
default: false
nullable: true
batch_prefix:
type: string
description: String to be prepended before each batch.
default: ''
nullable: true
batch_suffix:
type: string
description: String to be appended after each batch.
default: ''
nullable: true
field_delimiter:
type: string
description: String to join fields. This field be ignored when `record_template` is set.
default: ','
nullable: true
field_names:
type: array
description: List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.
example:
- ClientIP
- EdgeStartTimestamp
- RayID
items:
type: string
output_type:
type: string
description: Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.
enum:
- ndjson
- csv
default: ndjson
example: ndjson
record_delimiter:
type: string
description: String to be inserted in-between the records as separator.
default: ''
nullable: true
record_prefix:
type: string
description: String to be prepended before each record.
default: '{'
nullable: true
record_suffix:
type: string
description: String to be appended after each record.
default: '}
'
nullable: true
record_template:
type: string
description: String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.
default: ''
nullable: true
sample_rate:
type: number
format: float
description: Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.
default: 1
nullable: true
minimum: 0
maximum: 1
timestamp_format:
type: string
description: String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.
enum:
- unixnano
- unix
- rfc3339
default: unixnano
teams-devices_interval:
type: string
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
intel_url:
type: string
format: uri
description: URL(s) to filter submissions results by
example: https://www.cloudflare.com
aaa_mechanism:
type: string
description: The mechanism to which the notification has been dispatched.
example: test@example.com
tls-certificates-and-hostnames_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
magic_created_on:
type: string
format: date-time
description: When the route was created.
example: '2017-06-14T00:00:00Z'
readOnly: true
registrar-api_contact_properties:
type: object
required:
- first_name
- last_name
- address
- city
- state
- zip
- country
- phone
- organization
properties:
address:
$ref: '#/components/schemas/registrar-api_address'
address2:
$ref: '#/components/schemas/registrar-api_address2'
city:
$ref: '#/components/schemas/registrar-api_city'
country:
$ref: '#/components/schemas/registrar-api_country'
email:
$ref: '#/components/schemas/registrar-api_email'
fax:
$ref: '#/components/schemas/registrar-api_fax'
first_name:
$ref: '#/components/schemas/registrar-api_first_name'
id:
$ref: '#/components/schemas/registrar-api_contact_identifier'
last_name:
$ref: '#/components/schemas/registrar-api_last_name'
organization:
$ref: '#/components/schemas/registrar-api_organization'
phone:
$ref: '#/components/schemas/registrar-api_telephone'
state:
$ref: '#/components/schemas/registrar-api_state'
zip:
$ref: '#/components/schemas/registrar-api_zipcode'
aaa_webhook-id:
type: string
description: The unique identifier of a webhook
example: b115d5ec-15c6-41ee-8b76-92c449b5227b
readOnly: true
maxLength: 36
magic_schemas-created_on:
type: string
format: date-time
description: The date and time the tunnel was created.
example: '2017-06-14T00:00:00Z'
readOnly: true
teams-devices_exclude_office_ips:
type: boolean
description: Whether to add Microsoft IPs to Split Tunnel exclusions.
example: true
vectorize_index-preset:
type: string
description: Specifies the preset to use for the index.
enum:
- '@cf/baai/bge-small-en-v1.5'
- '@cf/baai/bge-base-en-v1.5'
- '@cf/baai/bge-large-en-v1.5'
- openai/text-embedding-ada-002
- cohere/embed-multilingual-v2.0
example: '@cf/baai/bge-small-en-v1.5'
magic_acl_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
acl:
$ref: '#/components/schemas/magic_acl'
logpush_frequency:
type: string
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
default: high
example: high
nullable: true
iam_schemas-identifier: {}
intel_content_categories:
description: Current content categories.
example:
- id: 155
name: Technology
super_category_id: 26
load-balancing_id_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/load-balancing_identifier'
tunnel_conns_inactive_at:
type: string
format: date-time
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'
nullable: true
stream_identifier:
type: string
description: A Cloudflare-generated unique identifier for a media item.
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
workers_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
workers_domain-response-collection:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_domain'
aaa_schemas-alert_type:
type: string
description: Type of notification that has been dispatched.
example: universal_ssl_event_type
teams-devices_description:
type: string
description: The description of the device posture rule.
example: The rule for admin serial numbers
aaa_components-schemas-type:
type: string
description: Type of webhook endpoint.
enum:
- slack
- generic
- gchat
example: slack
security-center_subjects:
type: array
items:
$ref: '#/components/schemas/security-center_subject'
teams-devices_device_settings_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device_settings_policy'
addressing_api-response-collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/addressing_result_info'
type: object
images_image_variant_fit:
type: string
description: The fit property describes how the width and height dimensions should be interpreted.
enum:
- scale-down
- contain
- cover
- crop
- pad
example: scale-down
digital-experience-monitoring_http_details_percentiles_response:
type: object
properties:
dnsResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
resourceFetchTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
serverResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
intel_components-schemas-response:
allOf:
- $ref: '#/components/schemas/intel_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/intel_ip-list'
pages_build_config:
type: object
description: Configs for the project build process.
properties:
build_caching:
type: boolean
description: Enable build caching for the project.
example: true
nullable: true
build_command:
type: string
description: Command used to build project.
example: npm run build
nullable: true
destination_dir:
type: string
description: Output directory of the build.
example: build
nullable: true
root_dir:
type: string
description: Directory to run the command.
example: /
nullable: true
web_analytics_tag:
type: string
description: The classifying tag for analytics.
example: cee1c73f6e4743d0b5e6bb1a0bcaabcc
nullable: true
web_analytics_token:
type: string
description: The auth token for analytics.
example: 021e1057c18547eca7b79f2516f06o7x
nullable: true
magic_name:
type: string
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
access_schemas-require:
type: array
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/access_rule'
addressing_service_identifier:
type: string
description: Identifier
example: 2db684ee7ca04e159946fd05b99e1bcd
maxLength: 32
tls-certificates-and-hostnames_mtls-management_components-schemas-status:
type: string
description: Certificate deployment status for the given service.
example: pending_deployment
iam_response_single:
allOf:
- $ref: '#/components/schemas/iam_api-response-single'
- type: object
properties:
result:
type: object
magic-visibility_pcaps_response_simple:
type: object
properties:
filter_v1:
$ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
id:
$ref: '#/components/schemas/magic-visibility_pcaps_id'
status:
$ref: '#/components/schemas/magic-visibility_pcaps_status'
submitted:
$ref: '#/components/schemas/magic-visibility_pcaps_submitted'
system:
$ref: '#/components/schemas/magic-visibility_pcaps_system'
time_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
type:
$ref: '#/components/schemas/magic-visibility_pcaps_type'
access_login_design:
properties:
background_color:
type: string
description: The background color on your login page.
example: '#c5ed1b'
footer_text:
type: string
description: The text at the bottom of your login page.
example: This is an example description.
header_text:
type: string
description: The text at the top of your login page.
example: This is an example description.
logo_path:
type: string
description: The URL of the logo on your login page.
example: https://example.com/logo.png
text_color:
type: string
description: The text color on your login page.
example: '#c5ed1b'
dns-firewall_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/dns-firewall_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/dns-firewall_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
intel_permission_list_item:
properties:
description:
$ref: '#/components/schemas/intel_description'
id:
$ref: '#/components/schemas/intel_id'
name:
$ref: '#/components/schemas/intel_name'
magic_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/magic_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/magic_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_requireAll:
type: boolean
description: Whether to check all disks for encryption.
example: true
stream_asc:
type: boolean
description: Lists videos in ascending order of creation.
default: false
example: true
secondary-dns_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
access_custom-pages_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_custom_page'
access_allowed_origins:
type: array
description: Allowed origins.
example:
- https://example.com
items: {}
tunnel_teamnet:
type: object
properties:
comment:
$ref: '#/components/schemas/tunnel_comment'
created_at:
description: Timestamp of when the route was created.
deleted_at:
type: string
format: date-time
description: Timestamp of when the route was deleted. If `null`, the route has not been deleted.
example: '2021-01-25T18:22:34.317854Z'
nullable: true
readOnly: true
id:
$ref: '#/components/schemas/tunnel_route_id'
network:
$ref: '#/components/schemas/tunnel_ip_network'
tun_type:
$ref: '#/components/schemas/tunnel_tunnel_type'
tunnel_id:
$ref: '#/components/schemas/tunnel_route_tunnel_id'
tunnel_name:
$ref: '#/components/schemas/tunnel_route_tunnel_name'
virtual_network_id:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
virtual_network_name:
$ref: '#/components/schemas/tunnel_vnet_name'
lists_list_id:
type: string
description: The unique ID of the list.
example: 2c0fc9fa937b11eaa1b71c4d701ab86e
readOnly: true
minLength: 32
maxLength: 32
stream_audio_identifier:
type: string
description: The unique identifier for an additional audio track.
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
magic_schemas-modified_tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_ipsec_tunnels:
type: array
items:
$ref: '#/components/schemas/magic_ipsec-tunnel'
intel-sinkholes_name:
type: string
description: The name of the sinkhole
lists_item_id:
type: string
description: The unique ID of the item in the List.
example: 34b12448945f11eaa1b71c4d701ab86e
rulesets_RulePosition:
type: object
title: Position
description: An object configuring where the rule will be placed.
aaa_last_failure:
type: string
format: date-time
description: Timestamp of the last time an attempt to dispatch a notification to this webhook failed.
example: '2020-10-26T18:25:04.532316Z'
readOnly: true
digital-experience-monitoring_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
magic_acl-subnet:
oneOf:
- $ref: '#/components/schemas/magic_ip-address'
- $ref: '#/components/schemas/magic_cidr'
teams-devices_allow_updates:
type: boolean
description: Whether to receive update notifications when a new version of the client is available.
example: true
teams-devices_sentinelone_input_request:
type: object
title: Sentinelone
required:
- path
- operating_system
properties:
operating_system:
type: string
description: Operating system
enum:
- windows
- linux
- mac
example: mac
path:
type: string
description: File path.
example: /bin/cat
sha256:
type: string
description: SHA-256.
example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
thumbprint:
type: string
description: Signing certificate thumbprint.
example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
r2_result_info:
type: object
properties:
cursor:
type: string
description: A continuation token that should be used to fetch the next page of results
example: 1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q=
per_page:
type: number
description: Maximum number of results on this page
example: 20
images_images_list_response_v2:
allOf:
- $ref: '#/components/schemas/images_api-response-collection-v2'
- properties:
result:
type: object
properties:
images:
type: array
items:
$ref: '#/components/schemas/images_image'
stream_caption_basic_upload:
type: object
required:
- file
properties:
file:
type: string
description: The WebVTT file containing the caption or subtitle content.
example: '@/Users/kyle/Desktop/tr.vtt'
workers_consumer_created:
type: object
properties:
created_on:
readOnly: true
dead_letter_queue:
$ref: '#/components/schemas/workers_dlq_name'
environment:
readOnly: true
queue_name:
readOnly: true
script_name:
readOnly: true
settings:
type: object
properties:
batch_size:
$ref: '#/components/schemas/workers_batch_size'
max_retries:
$ref: '#/components/schemas/workers_max_retries'
max_wait_time_ms:
$ref: '#/components/schemas/workers_max_wait_time_ms'
legacy-jhs_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/legacy-jhs_messages'
messages:
$ref: '#/components/schemas/legacy-jhs_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
workers_schemas-id:
type: string
description: ID of the namespace.
example: 5fd1cafff895419c8bcc647fc64ab8f0
logcontrol_cmb_config:
type: object
nullable: true
properties:
regions:
$ref: '#/components/schemas/logcontrol_regions'
workers_tail_consumers:
type: array
description: List of Workers that will consume logs from the attached Worker.
items:
$ref: '#/components/schemas/workers_tail_consumers_script'
workers_etag:
type: string
description: Hashed script content, can be used in a If-None-Match header when updating.
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
addressing_ip:
type: string
description: An IPv4 or IPv6 address.
example: 192.0.2.1
teams-devices_match:
type: array
description: The conditions that the client must match to run the rule.
items:
$ref: '#/components/schemas/teams-devices_match_item'
zero-trust-gateway_app-types:
oneOf:
- $ref: '#/components/schemas/zero-trust-gateway_application'
- $ref: '#/components/schemas/zero-trust-gateway_application_type'
type: object
readOnly: true
tls-certificates-and-hostnames_associationObject:
properties:
service:
$ref: '#/components/schemas/tls-certificates-and-hostnames_service'
status:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-status'
security-center_issue:
type: object
properties:
dismissed:
type: boolean
example: false
id:
type: string
issue_class:
$ref: '#/components/schemas/security-center_issueClass'
issue_type:
$ref: '#/components/schemas/security-center_issueType'
payload:
type: object
resolve_link:
type: string
resolve_text:
type: string
severity:
type: string
enum:
- Low
- Moderate
- Critical
since:
type: string
format: date-time
subject:
$ref: '#/components/schemas/security-center_subject'
timestamp:
type: string
format: date-time
calls_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
dlp_entry_id:
allOf:
- $ref: '#/components/schemas/dlp_uuid'
description: The ID for this entry
example: 719d1215-260f-41d0-8c32-eb320ad107f7
dns-firewall_dns-firewall:
type: object
required:
- id
- name
- upstream_ips
- dns_firewall_ips
- minimum_cache_ttl
- maximum_cache_ttl
- deprecate_any_requests
- ecs_fallback
- modified_on
properties:
attack_mitigation:
$ref: '#/components/schemas/dns-firewall_attack_mitigation'
deprecate_any_requests:
$ref: '#/components/schemas/dns-firewall_deprecate_any_requests'
dns_firewall_ips:
$ref: '#/components/schemas/dns-firewall_dns_firewall_ips'
ecs_fallback:
$ref: '#/components/schemas/dns-firewall_ecs_fallback'
id:
$ref: '#/components/schemas/dns-firewall_identifier'
maximum_cache_ttl:
$ref: '#/components/schemas/dns-firewall_maximum_cache_ttl'
minimum_cache_ttl:
$ref: '#/components/schemas/dns-firewall_minimum_cache_ttl'
modified_on:
$ref: '#/components/schemas/dns-firewall_modified_on'
name:
$ref: '#/components/schemas/dns-firewall_name'
negative_cache_ttl:
$ref: '#/components/schemas/dns-firewall_negative_cache_ttl'
origin_ips:
description: Deprecated alias for "upstream_ips".
deprecated: true
ratelimit:
$ref: '#/components/schemas/dns-firewall_ratelimit'
retries:
$ref: '#/components/schemas/dns-firewall_retries'
upstream_ips:
$ref: '#/components/schemas/dns-firewall_upstream_ips'
load-balancing_type:
type: string
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
default: http
example: https
access_path_cookie_attribute:
type: boolean
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
default: false
example: true
stream_input_rtmps:
type: object
description: Details for streaming to an live input using RTMPS.
properties:
streamKey:
$ref: '#/components/schemas/stream_input_rtmps_stream_key'
url:
$ref: '#/components/schemas/stream_input_rtmps_url'
access_tags_components-schemas-name:
type: string
description: The name of the tag
example: engineers
vectorize_index-name:
type: string
example: example-index
pattern: ^([a-z]+[a-z0-9_-]*[a-z0-9]+)$
tunnel_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
stream_webhook_request:
required:
- notificationUrl
properties:
notificationUrl:
$ref: '#/components/schemas/stream_notificationUrl'
lists_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
tunnel_ip_network_encoded:
type: string
description: IP/CIDR range in URL-encoded format
example: 172.16.0.0%2F16
workers_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
access_schemas-aud:
type: string
description: Audience tag.
example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
readOnly: true
maxLength: 64
bill-subs-api_currency:
type: string
description: The monetary unit in which pricing information is displayed.
example: USD
readOnly: true
security-center_issueTypes:
type: array
example:
- compliance_violation
- email_security
items:
$ref: '#/components/schemas/security-center_issueType'
rum_per_page:
type: number
description: Number of items to return per page of results.
example: 10
teams-devices_version:
type: string
description: The WARP client version.
example: 1.0.0
magic_wan:
type: object
properties:
description:
type: string
id:
$ref: '#/components/schemas/magic_identifier'
physport:
$ref: '#/components/schemas/magic_port'
priority:
type: integer
description: Priority of WAN for traffic loadbalancing.
site_id:
$ref: '#/components/schemas/magic_identifier'
static_addressing:
$ref: '#/components/schemas/magic_wan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
zero-trust-gateway_filters:
type: array
description: The protocol or layer to evaluate the traffic, identity, and device posture expressions.
example:
- http
items:
type: string
description: The protocol or layer to use.
enum:
- http
- dns
- l4
- egress
example: http
magic_components-schemas-tunnel_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_interconnect:
type: object
dns-firewall_negative_cache_ttl:
type: number
description: Negative DNS Cache TTL.
example: 900
nullable: true
minimum: 30
maximum: 36000
magic_schemas-description:
type: string
description: An optional description of the GRE tunnel.
example: Tunnel for ISP X
magic-transit_name:
type: string
description: Host name of the address, this may be the same as the IP address.
access_exclude:
type: array
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/access_rule'
intel_category_with_super_category_id:
properties:
id:
type: integer
name:
type: string
super_category_id:
type: integer
cloudforce-one_quota:
type: object
title: Quota
properties:
anniversary_date:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Anniversary date is when annual quota limit is refresh
- example: '2022-01-01T00:00:00Z'
quarter_anniversary_date:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Quater anniversary date is when quota limit is refreshed each quarter
- example: '2022-04-01T00:00:00Z'
quota:
type: integer
description: Tokens for the quarter
example: 120
remaining:
type: integer
description: Tokens remaining for the quarter
example: 64
secondary-dns_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/secondary-dns_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/secondary-dns_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic_route:
type: object
required:
- prefix
- nexthop
- priority
properties:
created_on:
$ref: '#/components/schemas/magic_created_on'
description:
$ref: '#/components/schemas/magic_description'
id:
$ref: '#/components/schemas/magic_identifier'
modified_on:
$ref: '#/components/schemas/magic_modified_on'
nexthop:
$ref: '#/components/schemas/magic_nexthop'
prefix:
$ref: '#/components/schemas/magic_prefix'
priority:
$ref: '#/components/schemas/magic_priority'
scope:
$ref: '#/components/schemas/magic_scope'
weight:
$ref: '#/components/schemas/magic_weight'
stream_live_input_modified:
type: string
format: date-time
description: The date and time the live input was last modified.
example: '2014-01-02T02:20:00Z'
magic-visibility_rule_identifier:
example: 2890e6fa406311ed9b5a23f70f6fb8cf
teams-devices_schemas-match:
type: string
description: The wirefilter expression to match devices.
example: user.identity == "test@cloudflare.com"
maxLength: 500
addressing_response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-prefixes'
stream_clipped_from_video_uid:
type: string
description: The unique video identifier (UID).
example: 023e105f4ecef8ad9ca31a8372d0c353
maxLength: 32
workers_namespace-response:
properties:
created_by:
$ref: '#/components/schemas/workers_identifier'
created_on:
$ref: '#/components/schemas/workers_created_on'
modified_by:
$ref: '#/components/schemas/workers_identifier'
modified_on:
$ref: '#/components/schemas/workers_modified_on'
namespace_id:
$ref: '#/components/schemas/workers_uuid'
namespace_name:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
workers_namespace-list-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_namespace-response'
intel_inherited_from:
type: string
description: Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable.
dlp_update_predefined_profile:
type: object
title: Update predefined profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
entries:
type: array
description: The entries for this profile.
items:
properties:
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
id:
$ref: '#/components/schemas/dlp_entry_id'
teams-devices_schemas-uuid:
type: string
description: Device ID.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
images_image_uploaded:
type: string
format: date-time
description: When the media item was uploaded.
example: '2014-01-02T02:20:00.123Z'
readOnly: true
aaa_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/aaa_messages'
messages:
$ref: '#/components/schemas/aaa_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
access_auth_domain:
type: string
description: The unique subdomain assigned to your Zero Trust organization.
example: test.cloudflareaccess.com
access_schemas-allow_authenticate_via_warp:
type: boolean
description: When set to true, users can authenticate to this application using their WARP session. When set to false this application will always require direct IdP authentication. This setting always overrides the organization setting for WARP authentication.
example: true
logpush_ownership_challenge:
type: string
description: Ownership challenge token to prove destination ownership.
example: '00000000000000000000'
maxLength: 4096
pattern: ^[a-zA-Z0-9/\+\.\-_]*$
magic_multiple_route_delete_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_routes:
type: object
addressing_schemas-ips:
type: array
description: The set of IPs on the Address Map.
items:
$ref: '#/components/schemas/addressing_address-maps-ip'
magic_schemas-name:
type: string
description: The name of the IPsec tunnel. The name cannot share a name with other tunnels.
example: IPsec_1
d1_database-version:
type: string
example: beta
pattern: ^(alpha|beta)$
turnstile_widget_detail:
type: object
description: A Turnstile widget's detailed configuration
required:
- sitekey
- secret
- created_on
- modified_on
- name
- domains
- mode
- region
- bot_fight_mode
- offlabel
- clearance_level
properties:
bot_fight_mode:
$ref: '#/components/schemas/turnstile_bot_fight_mode'
clearance_level:
$ref: '#/components/schemas/turnstile_clearance_level'
created_on:
$ref: '#/components/schemas/turnstile_created_on'
domains:
$ref: '#/components/schemas/turnstile_domains'
mode:
$ref: '#/components/schemas/turnstile_mode'
modified_on:
$ref: '#/components/schemas/turnstile_modified_on'
name:
$ref: '#/components/schemas/turnstile_name'
offlabel:
$ref: '#/components/schemas/turnstile_offlabel'
region:
$ref: '#/components/schemas/turnstile_region'
secret:
$ref: '#/components/schemas/turnstile_secret'
sitekey:
$ref: '#/components/schemas/turnstile_sitekey'
stream_keys:
type: object
properties:
created:
$ref: '#/components/schemas/stream_signing_key_created'
id:
$ref: '#/components/schemas/stream_schemas-identifier'
jwk:
$ref: '#/components/schemas/stream_jwk'
pem:
$ref: '#/components/schemas/stream_pem'
teams-devices_zero-trust-account-device-settings:
type: object
properties:
gateway_proxy_enabled:
type: boolean
description: Enable gateway proxy filtering on TCP.
example: true
gateway_udp_proxy_enabled:
type: boolean
description: Enable gateway proxy filtering on UDP.
example: true
root_certificate_installation_enabled:
type: boolean
description: Enable installation of cloudflare managed root certificate.
example: true
use_zt_virtual_ip:
type: boolean
description: Enable using CGNAT virtual IPv4.
example: true
access_gsuite_group_rule:
type: object
title: Google Workspace group
description: 'Matches a group in Google Workspace.
Requires a Google Workspace identity provider.'
required:
- gsuite
properties:
gsuite:
type: object
required:
- email
- connection_id
properties:
connection_id:
type: string
description: The ID of your Google Workspace identity provider.
example: ea85612a-29c8-46c2-bacb-669d65136971
email:
type: string
description: The email of the Google Workspace group.
example: devs@cloudflare.com
pages_domain_name:
type: string
description: Name of the domain.
example: this-is-my-domain-01.com
pattern: ^[a-z0-9][a-z0-9-]*$
turnstile_clearance_level:
type: string
description: 'If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance,
this setting can determine the clearance level to be set
'
enum:
- no_clearance
- jschallenge
- managed
- interactive
example: interactive
access_tags_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/access_tag'
tls-certificates-and-hostnames_schemas-serial_number:
type: string
description: The certificate serial number.
example: '235217144297995885180570755458463043449861756659'
readOnly: true
addressing_single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-prefixes'
digital-experience-monitoring_platform:
type: string
description: Operating system
example: windows
registrar-api_state:
type: string
description: State.
example: TX
rum_create-rule-request:
type: object
properties:
host:
type: string
example: example.com
inclusive:
type: boolean
description: Whether the rule includes or excludes traffic from being measured.
example: true
is_paused:
type: boolean
description: Whether the rule is paused or not.
example: false
paths:
type: array
example:
- '*'
items:
type: string
teams-devices_deleted:
type: boolean
description: True if the device was deleted.
example: true
teams-devices_config_request:
oneOf:
- $ref: '#/components/schemas/teams-devices_workspace_one_config_request'
- $ref: '#/components/schemas/teams-devices_crowdstrike_config_request'
- $ref: '#/components/schemas/teams-devices_uptycs_config_request'
- $ref: '#/components/schemas/teams-devices_intune_config_request'
- $ref: '#/components/schemas/teams-devices_kolide_config_request'
- $ref: '#/components/schemas/teams-devices_tanium_config_request'
- $ref: '#/components/schemas/teams-devices_sentinelone_s2s_config_request'
type: object
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
access_identity-providers:
anyOf:
- $ref: '#/components/schemas/access_azureAD'
- $ref: '#/components/schemas/access_centrify'
- $ref: '#/components/schemas/access_facebook'
- $ref: '#/components/schemas/access_github'
- $ref: '#/components/schemas/access_google'
- $ref: '#/components/schemas/access_google-apps'
- $ref: '#/components/schemas/access_linkedin'
- $ref: '#/components/schemas/access_oidc'
- $ref: '#/components/schemas/access_okta'
- $ref: '#/components/schemas/access_onelogin'
- $ref: '#/components/schemas/access_pingone'
- $ref: '#/components/schemas/access_saml'
- $ref: '#/components/schemas/access_yandex'
- $ref: '#/components/schemas/access_onetimepin'
r2_errors:
type: array
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
zero-trust-gateway_name:
type: string
description: The name of the list.
example: Admin Serial Numbers
magic-transit_target:
type: string
description: The target hostname, IPv6, or IPv6 address.
example: 1.1.1.1
workers_queue_binding:
type: object
required:
- name
- type
- queue_name
properties:
name:
$ref: '#/components/schemas/workers_binding_name'
queue_name:
type: string
description: Name of the Queue to bind to
example: my-queue
type:
type: string
description: The class of resource that the binding provides.
enum:
- queue
example: queue
magic-transit_colos:
type: array
description: If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.
example:
- den
- sin
items:
type: string
description: Source colo name.
access_schemas-auto_redirect_to_identity:
type: boolean
description: When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.
default: false
aaa_history_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
example:
- alert_body:
data:
custom_csr_id: ''
expires_on: null
hosts: []
id: '11111111111'
issuer: ''
method: txt
serial_number: ''
settings: null
signature: ''
status: ''
type: ''
uploaded_on: null
validation_errors: []
validation_records:
- cname: ''
cname_target: ''
emails: []
http_body: ''
http_url: ''
txt_name: _acme-challenge.example.com
txt_value: '11111111111'
metadata:
account: null
event:
created_at: null
id: ''
type: ssl.certificate.validation.failed
zone:
id: '11111111111'
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
policy_id: 35040955-3102-4710-938c-0f4eaf736e25
sent: '2021-10-08T17:52:17.571336Z'
items:
$ref: '#/components/schemas/aaa_history'
result_info:
type: object
example:
count: 1
page: 1
per_page: 20
legacy-jhs_schemas-rule:
allOf:
- $ref: '#/components/schemas/legacy-jhs_rule'
- properties:
scope:
type: object
description: All zones owned by the user will have the rule applied.
readOnly: true
properties:
email:
$ref: '#/components/schemas/legacy-jhs_email'
id:
$ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
type:
description: The scope of the rule.
enum:
- user
- organization
example: user
readOnly: true
type: object
required:
- id
- mode
- allowed_modes
- configuration
- scope
load-balancing_schemas-references_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- properties:
result:
type: array
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:
type: object
properties:
reference_type:
type: string
enum:
- '*'
- referral
- referrer
resource_id:
type: string
resource_name:
type: string
resource_type:
type: string
access_email_list_rule:
type: object
title: Email list
description: Matches an email address from a list.
required:
- email_list
properties:
email_list:
type: object
required:
- id
properties:
id:
type: string
description: The ID of a previously created email list.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
workers_script-response:
properties:
created_on:
$ref: '#/components/schemas/workers_created_on'
etag:
$ref: '#/components/schemas/workers_etag'
id:
type: string
description: The id of the script in the Workers system. Usually the script name.
example: my-workers-script
readOnly: true
logpush:
$ref: '#/components/schemas/workers_logpush'
modified_on:
$ref: '#/components/schemas/workers_modified_on'
pipeline_hash:
$ref: '#/components/schemas/workers_pipeline_hash'
placement_mode:
$ref: '#/components/schemas/workers_placement_mode'
tail_consumers:
$ref: '#/components/schemas/workers_tail_consumers'
usage_model:
$ref: '#/components/schemas/workers_usage_model'
access_service-tokens:
type: object
properties:
client_id:
$ref: '#/components/schemas/access_client_id'
created_at:
$ref: '#/components/schemas/access_timestamp'
duration:
$ref: '#/components/schemas/access_duration'
id:
description: The ID of the service token.
name:
$ref: '#/components/schemas/access_service-tokens_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
intel_domain:
properties:
additional_information:
$ref: '#/components/schemas/intel_additional_information'
application:
$ref: '#/components/schemas/intel_application'
content_categories:
$ref: '#/components/schemas/intel_content_categories'
domain:
$ref: '#/components/schemas/intel_domain_name'
inherited_content_categories:
$ref: '#/components/schemas/intel_inherited_content_categories'
inherited_from:
$ref: '#/components/schemas/intel_inherited_from'
inherited_risk_types:
$ref: '#/components/schemas/intel_inherited_risk_types'
popularity_rank:
$ref: '#/components/schemas/intel_popularity_rank'
resolves_to_refs:
$ref: '#/components/schemas/intel_resolves_to_refs'
risk_score:
$ref: '#/components/schemas/intel_risk_score'
risk_types:
$ref: '#/components/schemas/intel_risk_types'
access_api-response-collection:
allOf:
- $ref: '#/components/schemas/access_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/access_result_info'
type: object
dlp_create_custom_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dlp_custom_profile'
load-balancing_schemas-id_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
teams-devices_schemas-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-posture-integrations'
workers-kv_create_rename_namespace_body:
type: object
required:
- title
properties:
title:
$ref: '#/components/schemas/workers-kv_namespace_title'
zero-trust-gateway_public_key:
type: string
description: SSH encryption public key
example: 1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=
logpush_id:
type: integer
description: Unique id of the job.
minimum: 1
logcontrol_api-response-single:
allOf:
- $ref: '#/components/schemas/logcontrol_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
magic_weight:
type: integer
description: Optional weight of the ECMP scope - if provided.
workers-kv_bulk_delete:
type: array
items:
$ref: '#/components/schemas/workers-kv_key_name_bulk'
vectorize_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/vectorize_messages'
messages:
$ref: '#/components/schemas/vectorize_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
registrar-api_can_register:
type: boolean
description: Indicates if the domain can be registered as a new domain.
example: false
tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on:
type: string
format: date-time
description: This is the time the certificate was uploaded.
example: '2022-11-22T17:32:30.467938Z'
registrar-api_fax:
type: string
description: Contact fax number.
example: 123-867-5309
access_onelogin:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
onelogin_account:
type: string
description: Your OneLogin account url
example: https://mycompany.onelogin.com
type: object
title: OneLogin
workers_max_retries:
type: number
example: 3
secondary-dns_port:
type: number
description: DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.
example: 53
teams-devices_tanium_input_request:
type: object
title: Tanium S2S Input
required:
- connection_id
properties:
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
eid_last_seen:
type: string
description: For more details on eid last seen, refer to the Tanium documentation.
example: '2023-07-20T23:16:32Z'
operator:
type: string
description: Operator to evaluate risk_level or eid_last_seen.
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
risk_level:
type: string
description: For more details on risk level, refer to the Tanium documentation.
enum:
- low
- medium
- high
- critical
example: low
scoreOperator:
type: string
description: Score Operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
total_score:
type: number
description: For more details on total score, refer to the Tanium documentation.
example: 1
dns-firewall_modified_on:
type: string
format: date-time
description: Last modification of DNS Firewall cluster.
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
workers_name:
type: string
example: example-queue
teams-devices_os_version:
type: string
description: The operating system version.
example: 10.0.0
access_custom-pages_components-schemas-name:
type: string
description: Custom page name.
legacy-jhs_response_single:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-single'
- type: object
properties:
result:
type: object
teams-devices_intune_input_request:
type: object
title: Intune S2S Input
required:
- connection_id
- compliance_status
properties:
compliance_status:
type: string
description: Compliance Status
enum:
- compliant
- noncompliant
- unknown
- notapplicable
- ingraceperiod
- error
example: compliant
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
security-center_count:
type: integer
description: Total number of results
example: 1
digital-experience-monitoring_percentiles:
type: object
properties:
p50:
type: number
description: p50 observed in the time period
nullable: true
p90:
type: number
description: p90 observed in the time period
nullable: true
p95:
type: number
description: p95 observed in the time period
nullable: true
p99:
type: number
description: p99 observed in the time period
nullable: true
magic_route_update_many_request:
type: object
required:
- routes
properties:
routes:
type: array
items:
$ref: '#/components/schemas/magic_route_update_single_request'
images_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
workers_script-response-collection:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/workers_script-response'
d1_database-name:
type: string
example: my-database
pattern: ^[a-z0-9][a-z0-9-_]*$
load-balancing_interval:
type: integer
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.
default: 60
access_yandex:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
$ref: '#/components/schemas/access_generic-oauth-config'
type: object
title: Yandex
magic-transit_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic_cloudflare_ipsec_endpoint:
type: string
description: The IP address assigned to the Cloudflare side of the IPsec tunnel.
example: 203.0.113.1
secondary-dns_api-response-collection:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/secondary-dns_result_info'
type: object
images_image_direct_upload_response_v2:
allOf:
- $ref: '#/components/schemas/images_api-response-single'
- properties:
result:
properties:
id:
type: string
description: Image unique identifier.
example: e22e9e6b-c02b-42fd-c405-6c32af5fe600
readOnly: true
maxLength: 32
uploadURL:
type: string
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
dlp_api-response-collection:
allOf:
- $ref: '#/components/schemas/dlp_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/dlp_result_info'
type: object
tunnel_created_at:
type: string
format: date-time
description: Timestamp of when the tunnel was created.
example: '2021-01-25T18:22:34.317854Z'
access_warp_auth_session_duration:
type: string
description: 'The amount of time that tokens issued for applications will be valid. Must be in the format `30m` or `2h45m`. Valid time units are: m, h.'
example: 24h
registrar-api_api-response-single:
allOf:
- $ref: '#/components/schemas/registrar-api_api-response-common'
- properties:
result:
type: object
nullable: true
type: object
rulesets_RuleCategory:
type: string
title: Category
description: A category of the rule.
example: directory-traversal
minLength: 1
legacy-jhs_country_configuration:
title: A 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:
type: string
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
dlp_predefined_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
tls-certificates-and-hostnames_schemas-issuer:
type: string
description: The certificate authority that issued the certificate.
example: O=Example Inc.,L=California,ST=San Francisco,C=US
readOnly: true
teams-devices_device-posture-integrations:
type: object
properties:
config:
$ref: '#/components/schemas/teams-devices_config_response'
id:
$ref: '#/components/schemas/teams-devices_uuid'
interval:
$ref: '#/components/schemas/teams-devices_interval'
name:
$ref: '#/components/schemas/teams-devices_components-schemas-name'
type:
$ref: '#/components/schemas/teams-devices_schemas-type'
images_image_hero_url:
type: string
format: uri
description: URI to hero variant for an image.
example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
readOnly: true
stream_position:
type: string
description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.'
default: upperRight
example: center
logcontrol_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/logcontrol_messages'
messages:
$ref: '#/components/schemas/logcontrol_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
rulesets_CreateOrUpdateRuleRequest:
allOf:
- $ref: '#/components/schemas/rulesets_RuleRequest'
- properties:
position:
oneOf:
- allOf:
- $ref: '#/components/schemas/rulesets_RulePosition'
- title: Before position
properties:
before:
type: string
title: Before
description: The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top.
example: da5e8e506c8e7877fe06cdf4c41add54
pattern: ^(?:[0-9a-f]{32})?$
- allOf:
- $ref: '#/components/schemas/rulesets_RulePosition'
- title: After position
properties:
after:
type: string
title: After
description: The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom.
example: 5bccdbb2a5142cd25cad8591255bd209
pattern: ^(?:[0-9a-f]{32})?$
- allOf:
- $ref: '#/components/schemas/rulesets_RulePosition'
- title: Index position
properties:
index:
type: number
title: Index
description: An index at which to place the rule, where index 1 is the first rule.
example: 1
minimum: 1
intel_asn:
type: integer
legacy-jhs_schemas-filters:
type: object
properties:
configuration.target:
type: string
description: The target to search in existing rules.
enum:
- ip
- ip_range
- asn
- country
example: ip
configuration.value:
type: string
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`.
Notes: 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
match:
type: string
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
default: all
mode:
$ref: '#/components/schemas/legacy-jhs_schemas-mode'
notes:
type: string
description: 'The string to search for in the notes of existing IP Access rules.
Notes: 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
logpush_destination_exists_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
exists:
type: boolean
example: false
workers-kv_api-response-single:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
registrar-api_registry_statuses:
type: string
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
digital-experience-monitoring_traceroute_details_percentiles_response:
type: object
properties:
hopsCount:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
packetLossPct:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
roundTripTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_percentiles'
registrar-api_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_preview:
type: string
format: uri
description: The video's preview page URI. This field is omitted until encoding is complete.
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch
teams-devices_identifier:
example: 699d98642c564d2e855e9661899b7252
zero-trust-gateway_enabled_download_phase:
type: boolean
description: Enable anti-virus scanning on downloads.
example: false
calls_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/calls_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/calls_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
intel_url_param:
type: object
properties:
url:
$ref: '#/components/schemas/intel_url'
tunnel_icmp_proxy_enabled:
type: boolean
description: A flag to enable the ICMP proxy for the account network.
example: true
digital-experience-monitoring_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
workers_binding_name:
type: string
description: A JavaScript variable name for the binding.
example: myBinding
readOnly: true
registrar-api_auto_renew:
type: boolean
description: Auto-renew controls whether subscription is automatically renewed upon domain expiration.
example: true
zero-trust-gateway_networks:
type: array
description: A list of network ranges that requests from this location would originate from.
items:
$ref: '#/components/schemas/zero-trust-gateway_network'
logpush_api-response-single:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
workers-kv_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/workers-kv_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/workers-kv_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
access_http_only_cookie_attribute:
type: boolean
description: Enables the HttpOnly cookie attribute, which increases security against XSS attacks.
default: true
example: true
workers_service_binding:
type: object
required:
- name
- type
- service
- environment
properties:
environment:
type: string
description: Optional environment if the Worker utilizes one.
example: production
name:
$ref: '#/components/schemas/workers_binding_name'
service:
type: string
description: Name of Worker to bind to
example: my-worker
type:
type: string
description: The class of resource that the binding provides.
enum:
- service
example: service
aaa_response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: object
example:
Origin Monitoring:
- description: High levels of 5xx HTTP errors at your origin.
display_name: Origin Error Rate Alert
filter_options:
- AvailableValues: null
ComparisonOperator: ==
Key: zones
Range: 1-n
- AvailableValues:
- Description: Service-Level Objective of 99.7
ID: '99.7'
- Description: Service-Level Objective of 99.8
ID: '99.8'
ComparisonOperator: '>='
Key: slo
Range: 0-1
type: http_alert_origin_error
workers_queue_updated:
type: object
properties:
created_on:
readOnly: true
modified_on:
readOnly: true
queue_id:
readOnly: true
queue_name:
$ref: '#/components/schemas/workers_renamed_name'
magic_modified_on:
type: string
format: date-time
description: When the route was last modified.
example: '2017-06-14T05:20:00Z'
readOnly: true
d1_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
calls_app_editable_fields:
type: object
properties:
name:
$ref: '#/components/schemas/calls_name'
intel_create_feed_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_indicator_feed_item'
access_is_ui_read_only:
type: boolean
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'
workers_modified_on:
type: string
format: date-time
description: When the script was last modified.
example: '2017-01-01T00:00:00Z'
readOnly: true
access_saml_group_rule:
type: object
title: SAML group
description: 'Matches a SAML group.
Requires a SAML identity provider.'
required:
- saml
properties:
saml:
type: object
required:
- attribute_name
- attribute_value
properties:
attribute_name:
type: string
description: The name of the SAML attribute.
example: group
attribute_value:
type: string
description: The SAML attribute value to look for.
example: devs@cloudflare.com
magic_lan-acl-configuration:
type: object
required:
- lan_id
properties:
lan_id:
type: string
description: The identifier for the LAN you want to create an ACL policy with.
lan_name:
type: string
description: The name of the LAN based on the provided lan_id.
ports:
type: array
description: Array of ports on the provided LAN that will be included in the ACL. If no ports are provided, communication on any port on this LAN is allowed.
items:
$ref: '#/components/schemas/magic_port'
subnets:
type: array
description: Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed.
items:
$ref: '#/components/schemas/magic_acl-subnet'
magic_wans_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
wans:
type: array
items:
$ref: '#/components/schemas/magic_wan'
access_self_hosted_props:
type: object
title: Self Hosted Application
required:
- type
- domain
properties:
allow_authenticate_via_warp:
$ref: '#/components/schemas/access_schemas-allow_authenticate_via_warp'
allowed_idps:
$ref: '#/components/schemas/access_allowed_idps'
app_launcher_visible:
$ref: '#/components/schemas/access_app_launcher_visible'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
cors_headers:
$ref: '#/components/schemas/access_cors_headers'
custom_deny_message:
$ref: '#/components/schemas/access_custom_deny_message'
custom_deny_url:
$ref: '#/components/schemas/access_custom_deny_url'
custom_non_identity_deny_url:
$ref: '#/components/schemas/access_custom_non_identity_deny_url'
custom_pages:
$ref: '#/components/schemas/access_schemas-custom_pages'
domain:
$ref: '#/components/schemas/access_domain'
enable_binding_cookie:
$ref: '#/components/schemas/access_enable_binding_cookie'
http_only_cookie_attribute:
$ref: '#/components/schemas/access_http_only_cookie_attribute'
logo_url:
$ref: '#/components/schemas/access_logo_url'
name:
$ref: '#/components/schemas/access_apps_components-schemas-name'
path_cookie_attribute:
$ref: '#/components/schemas/access_path_cookie_attribute'
same_site_cookie_attribute:
$ref: '#/components/schemas/access_same_site_cookie_attribute'
self_hosted_domains:
$ref: '#/components/schemas/access_self_hosted_domains'
service_auth_401_redirect:
$ref: '#/components/schemas/access_service_auth_401_redirect'
session_duration:
$ref: '#/components/schemas/access_schemas-session_duration'
skip_interstitial:
$ref: '#/components/schemas/access_skip_interstitial'
tags:
$ref: '#/components/schemas/access_tags'
type:
type: string
description: The application type.
example: self_hosted
workers_created_on:
type: string
format: date-time
description: When the script was created.
example: '2017-01-01T00:00:00Z'
readOnly: true
tunnel_api-response-collection:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/tunnel_result_info'
type: object
bill-subs-api_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
secondary-dns_components-schemas-id_response:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
magic-visibility_mnm_config_name:
type: string
description: The account name.
example: cloudflare user's account
logcontrol_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
images_image_variant_width:
type: number
description: Maximum width in image pixels.
example: 1366
minimum: 1
access_ca_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_ca'
aaa_id_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/aaa_uuid'
aaa_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
addressing_loa_upload_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
type: object
properties:
filename:
type: string
description: Name of LOA document.
example: document.pdf
tunnel_ip:
type: string
example: 10.1.0.137
images_images_list_continuation_token:
type: string
description: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.
example: iD0bxlWFSVUWsDHbzIqvDkgBW4otifAAuGXLz1n8BQA
nullable: true
readOnly: true
maxLength: 32
teams-devices_precedence:
type: number
description: The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.
example: 100
hyperdrive_hyperdrive-scheme:
type: string
description: Specifies the URL scheme used to connect to your origin database.
enum:
- postgres
- postgresql
default: postgres
magic_schemas-tunnel_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_ipsec_tunnel:
type: object
teams-devices_split_tunnel_include_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel_include'
access_github:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
$ref: '#/components/schemas/access_generic-oauth-config'
type: object
title: GitHub
teams-devices_include:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel_include'
tunnel_vnet_id:
type: string
description: UUID of the virtual network.
example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
teams-devices_match_item:
type: object
properties:
platform:
$ref: '#/components/schemas/teams-devices_platform'
zero-trust-gateway_components-schemas-name:
type: string
description: The name of the rule.
example: block bad websites
iam_single_member_response:
allOf:
- $ref: '#/components/schemas/iam_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/iam_member'
d1_params:
type: array
example:
- firstParam
- secondParam
items:
type: string
access_is_default:
type: boolean
description: Whether this is the default group
turnstile_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_output_identifier:
type: string
description: A unique identifier for the output.
example: baea4d9c515887b80289d5c33cf01145
maxLength: 32
email_email:
type: string
description: The contact email address of the user.
example: user@example.com
maxLength: 90
bill-subs-api_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/bill-subs-api_messages'
messages:
$ref: '#/components/schemas/bill-subs-api_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_tunnel_health_check:
type: object
properties:
enabled:
type: boolean
description: Determines whether to run healthchecks for a tunnel.
default: true
example: true
rate:
type: string
description: How frequent the health check is run. The default value is `mid`.
enum:
- low
- mid
- high
default: mid
example: low
target:
type: string
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:
type: string
description: The type of healthcheck to run, reply or request. The default value is `reply`.
enum:
- reply
- request
default: reply
example: request
addressing_can_delete:
type: boolean
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
access_action:
type: string
description: The event that occurred, such as a login attempt.
example: login
workers_namespace-script-response:
type: object
description: Details about a worker uploaded to a Workers for Platforms namespace.
properties:
created_on:
$ref: '#/components/schemas/workers_created_on'
dispatch_namespace:
$ref: '#/components/schemas/workers_dispatch_namespace_name'
modified_on:
$ref: '#/components/schemas/workers_modified_on'
script:
$ref: '#/components/schemas/workers_script-response'
pages_deployments:
type: object
properties:
aliases:
type: array
description: A list of alias URLs pointing to this deployment.
example:
- https://branchname.projectname.pages.dev
nullable: true
readOnly: true
items: {}
build_config:
readOnly: true
created_on:
type: string
format: date-time
description: When the deployment was created.
example: '2021-03-09T00:55:03.923456Z'
readOnly: true
deployment_trigger:
type: object
description: Info about what caused the deployment.
readOnly: true
properties:
metadata:
type: object
description: Additional info about the trigger.
properties:
branch:
type: string
description: Where the trigger happened.
example: main
readOnly: true
commit_hash:
type: string
description: Hash of the deployment trigger commit.
example: ad9ccd918a81025731e10e40267e11273a263421
readOnly: true
commit_message:
type: string
description: Message of the deployment trigger commit.
example: Update index.html
readOnly: true
type:
type: string
description: What caused the deployment.
example: ad_hoc
readOnly: true
pattern: push|ad_hoc
env_vars:
type: object
description: A dict of env variables to build this deploy.
example:
BUILD_VERSION:
value: '3.3'
ENV:
value: STAGING
readOnly: true
environment:
type: string
description: Type of deploy.
example: preview
readOnly: true
pattern: preview|production
id:
type: string
description: Id of the deployment.
example: f64788e9-fccd-4d4a-a28a-cb84f88f6
readOnly: true
is_skipped:
type: boolean
description: If the deployment has been skipped.
example: true
readOnly: true
latest_stage:
readOnly: true
modified_on:
type: string
format: date-time
description: When the deployment was last modified.
example: 2021-03-09 00:58:59.045000+00:00
readOnly: true
project_id:
type: string
description: Id of the project.
example: 7b162ea7-7367-4d67-bcde-1160995d5
readOnly: true
project_name:
type: string
description: Name of the project.
example: ninjakittens
readOnly: true
short_id:
type: string
description: Short Id (8 character) of the deployment.
example: f64788e9
readOnly: true
source:
readOnly: true
stages:
type: array
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
readOnly: true
items:
$ref: '#/components/schemas/pages_stage'
url:
type: string
description: The live URL to view this deployment.
example: https://f64788e9.ninjakittens.pages.dev
readOnly: true
access_uid:
description: The unique API identifier for the user.
registrar-api_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/registrar-api_messages'
messages:
$ref: '#/components/schemas/registrar-api_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
workers_schemas-environment:
type: string
description: Worker environment associated with the zone and hostname.
example: production
dns-firewall_api-response-collection:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/dns-firewall_result_info'
type: object
stream_captions:
type: object
properties:
label:
$ref: '#/components/schemas/stream_label'
language:
$ref: '#/components/schemas/stream_language'
dlp_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/dlp_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/dlp_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_switch_locked:
type: boolean
description: Whether to allow the user to turn off the WARP switch and disconnect the client.
example: true
security-center_severityQueryParam:
type: array
example:
- low
- moderate
items:
type: string
enum:
- low
- moderate
- critical
load-balancing_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
workers_do_binding:
type: object
required:
- name
- type
- class_name
properties:
class_name:
type: string
description: The exported class name of the Durable Object
example: MyDurableObject
environment:
type: string
description: The environment of the script_name to bind to
example: production
name:
$ref: '#/components/schemas/workers_binding_name'
namespace_id:
$ref: '#/components/schemas/workers_namespace_identifier'
script_name:
type: string
description: The script where the Durable Object is defined, if it is external to this Worker
example: my-other-worker
type:
type: string
description: The class of resource that the binding provides.
enum:
- durable_object_namespace
example: durable_object_namespace
magic_connector-id:
type: string
description: Magic WAN Connector identifier tag.
example: ac60d3d0435248289d446cedd870bcf4
magic_schemas-tunnel_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
ipsec_tunnel:
type: object
workers_script_identifier:
type: string
example: 8ee82b3a2c0f42928b8f14dae4a97121
readOnly: true
maxLength: 32
teams-devices_input:
oneOf:
- $ref: '#/components/schemas/teams-devices_file_input_request'
- $ref: '#/components/schemas/teams-devices_unique_client_id_input_request'
- $ref: '#/components/schemas/teams-devices_domain_joined_input_request'
- $ref: '#/components/schemas/teams-devices_os_version_input_request'
- $ref: '#/components/schemas/teams-devices_firewall_input_request'
- $ref: '#/components/schemas/teams-devices_sentinelone_input_request'
- $ref: '#/components/schemas/teams-devices_carbonblack_input_request'
- $ref: '#/components/schemas/teams-devices_disk_encryption_input_request'
- $ref: '#/components/schemas/teams-devices_application_input_request'
- $ref: '#/components/schemas/teams-devices_client_certificate_input_request'
- $ref: '#/components/schemas/teams-devices_workspace_one_input_request'
- $ref: '#/components/schemas/teams-devices_crowdstrike_input_request'
- $ref: '#/components/schemas/teams-devices_intune_input_request'
- $ref: '#/components/schemas/teams-devices_kolide_input_request'
- $ref: '#/components/schemas/teams-devices_tanium_input_request'
- $ref: '#/components/schemas/teams-devices_sentinelone_s2s_input_request'
type: object
description: The value to be checked against.
example:
operating_system: linux
path: /bin/cat
thumbprint: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
d1_api-response-single:
allOf:
- $ref: '#/components/schemas/d1_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
teams-devices_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
access_decision:
type: string
description: The action Access will take if a user matches this policy.
enum:
- allow
- deny
- non_identity
- bypass
example: allow
workers_domain-response-single:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- type: object
properties:
result:
$ref: '#/components/schemas/workers_domain'
dns-custom-nameservers_ns_name:
type: string
format: hostname
description: The FQDN of the name server.
example: ns1.example.com
intel_indicator_feed_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-common'
- properties:
result:
type: array
example:
- created_on: '2023-05-12T12:21:56.777653Z'
description: user specified description 1
id: 1
modified_on: '2023-06-18T03:13:34.123321Z'
name: user_specified_name_1
- created_on: '2023-05-21T21:43:52.867525Z'
description: User specified description 2
id: 2
modified_on: '2023-06-28T18:46:18.764425Z'
name: user_specified_name_2
items:
$ref: '#/components/schemas/intel_indicator_feed_item'
access_app_domain:
type: string
description: The URL of the Access application.
example: test.example.com/admin
digital-experience-monitoring_personEmail:
type: string
description: User contact email address
access_logo_url:
type: string
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
access_certificates_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_certificates'
security-center_issueClasses:
type: array
example:
- a_record_dangling
- always_use_https_not_enabled
items:
$ref: '#/components/schemas/security-center_issueClass'
magic_acl_update_request:
type: object
properties:
acl:
type: object
properties:
description:
type: string
description: Description for the ACL.
example: Allows local traffic between PIN pads and cash register.
lan_1:
$ref: '#/components/schemas/magic_lan-acl-configuration'
lan_2:
$ref: '#/components/schemas/magic_lan-acl-configuration'
name:
type: string
description: The name of the ACL.
example: PIN Pad - Cash Register
protocols:
type: array
items:
type: string
description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
enum:
- tcp
- udp
- icmp
load-balancing_schemas-disabled_at:
type: string
format: date-time
description: This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
readOnly: true
rulesets_RuleResponse:
allOf:
- $ref: '#/components/schemas/rulesets_RuleRequest'
- required:
- id
- expression
- action
- ref
- enabled
workers-kv_bulk_write:
type: array
items:
type: object
properties:
base64:
type: boolean
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.
default: false
expiration:
$ref: '#/components/schemas/workers-kv_expiration'
expiration_ttl:
$ref: '#/components/schemas/workers-kv_expiration_ttl'
key:
$ref: '#/components/schemas/workers-kv_key_name_bulk'
metadata:
$ref: '#/components/schemas/workers-kv_list_metadata'
value:
type: string
description: A UTF-8 encoded string to be stored, up to 25 MiB in length.
example: Some string
maxLength: 26214400
required:
- key
- value
digital-experience-monitoring_timing_aggregates:
type: object
required:
- history
properties:
avgMs:
type: integer
nullable: true
history:
type: array
items:
$ref: '#/components/schemas/digital-experience-monitoring_aggregate_stat'
overTime:
type: object
nullable: true
required:
- values
- timePeriod
properties:
timePeriod:
$ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period'
values:
type: array
items:
$ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_slot'
workers_migration_step:
type: object
properties:
deleted_classes:
type: array
description: A list of classes to delete Durable Object namespaces from.
items:
type: string
new_classes:
type: array
description: A list of classes to create Durable Object namespaces from.
items:
type: string
renamed_classes:
type: array
description: A list of classes with Durable Object namespaces that were renamed.
items:
type: object
properties:
from:
type: string
to:
type: string
transferred_classes:
type: array
description: A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
items:
type: object
properties:
from:
type: string
from_script:
type: string
to:
type: string
iam_role:
type: object
required:
- id
- name
- description
- permissions
properties:
description:
type: string
description: Description of role's permissions.
example: Administrative access to the entire Account
readOnly: true
id:
$ref: '#/components/schemas/iam_role_components-schemas-identifier'
name:
type: string
description: Role name.
example: Account Administrator
readOnly: true
maxLength: 120
permissions:
allOf:
- $ref: '#/components/schemas/iam_permissions'
- readOnly: true
rulesets_RuleAction:
type: string
title: Action
description: The action to perform when the rule matches.
example: log
pattern: ^[a-z]+$
digital-experience-monitoring_aggregate_stat:
type: object
required:
- timePeriod
properties:
avgMs:
type: integer
nullable: true
deltaPct:
type: number
format: float
nullable: true
timePeriod:
$ref: '#/components/schemas/digital-experience-monitoring_aggregate_time_period'
calls_identifier:
type: string
description: A Cloudflare-generated unique identifier for a item.
example: 2a95132c15732412d22c1476fa83f27a
minLength: 32
maxLength: 32
access_custom_page_without_html:
type: object
required:
- name
- type
properties:
app_count:
$ref: '#/components/schemas/access_app_count'
created_at:
$ref: '#/components/schemas/access_timestamp'
name:
$ref: '#/components/schemas/access_custom-pages_components-schemas-name'
type:
$ref: '#/components/schemas/access_schemas-type'
uid:
$ref: '#/components/schemas/access_uuid'
updated_at:
$ref: '#/components/schemas/access_timestamp'
access_tags:
type: array
description: The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard.
items:
type: string
description: The tag associated with an application.
example: engineers
magic-visibility_pcaps_filter_v1:
type: object
description: The packet capture filter. When this field is empty, all packets are captured.
properties:
destination_address:
type: string
description: The destination IP address of the packet.
example: 1.2.3.4
destination_port:
type: number
description: The destination port of the packet.
example: 80
protocol:
type: number
description: The protocol number of the packet.
example: 6
source_address:
type: string
description: The source IP address of the packet.
example: 1.2.3.4
source_port:
type: number
description: The source port of the packet.
example: 123
dlp_V4Response:
type: object
required:
- success
- errors
- messages
properties:
errors:
type: array
items:
$ref: '#/components/schemas/dlp_V4ResponseMessage'
messages:
type: array
items:
$ref: '#/components/schemas/dlp_V4ResponseMessage'
result_info:
allOf:
- $ref: '#/components/schemas/dlp_V4ResponsePagination'
success:
type: boolean
turnstile_name:
type: string
description: 'Human readable widget name. Not unique. Cloudflare suggests that you
set this to a meaningful string to make it easier to identify your
widget, and where it is used.
'
example: blog.cloudflare.com login form
minLength: 1
maxLength: 254
zero-trust-gateway_application:
type: object
properties:
application_type_id:
$ref: '#/components/schemas/zero-trust-gateway_app_type_id'
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
id:
$ref: '#/components/schemas/zero-trust-gateway_app_id'
name:
$ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-name'
rulesets_Errors:
type: array
title: Errors
description: A list of error messages.
items:
$ref: '#/components/schemas/rulesets_Message'
intel_description:
type: string
description: The description of the example test
magic-transit_max_ttl:
type: integer
description: Max TTL.
default: 15
minimum: 0
maximum: 64
teams-devices_workspace_one_config_request:
type: object
title: Workspace One Config
required:
- api_url
- auth_url
- client_id
- client_secret
properties:
api_url:
type: string
description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
example: https://as123.awmdm.com/API
auth_url:
type: string
description: The Workspace One Authorization URL depending on your region.
example: https://na.uemauth.vmwservices.com/connect/token
client_id:
type: string
description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
example: example client id
client_secret:
type: string
description: The Workspace One client secret provided in the Workspace One Admin Dashboard.
example: example client secret
load-balancing_pool:
type: object
properties:
check_regions:
$ref: '#/components/schemas/load-balancing_check_regions'
created_on:
$ref: '#/components/schemas/load-balancing_timestamp'
description:
$ref: '#/components/schemas/load-balancing_schemas-description'
disabled_at:
$ref: '#/components/schemas/load-balancing_schemas-disabled_at'
enabled:
$ref: '#/components/schemas/load-balancing_enabled'
id:
$ref: '#/components/schemas/load-balancing_schemas-identifier'
latitude:
$ref: '#/components/schemas/load-balancing_latitude'
load_shedding:
$ref: '#/components/schemas/load-balancing_load_shedding'
longitude:
$ref: '#/components/schemas/load-balancing_longitude'
minimum_origins:
$ref: '#/components/schemas/load-balancing_minimum_origins'
modified_on:
$ref: '#/components/schemas/load-balancing_timestamp'
monitor:
$ref: '#/components/schemas/load-balancing_monitor_id'
name:
$ref: '#/components/schemas/load-balancing_name'
notification_email:
$ref: '#/components/schemas/load-balancing_notification_email'
notification_filter:
$ref: '#/components/schemas/load-balancing_notification_filter'
origin_steering:
$ref: '#/components/schemas/load-balancing_origin_steering'
origins:
$ref: '#/components/schemas/load-balancing_origins'
magic_routes_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
routes:
type: array
items:
$ref: '#/components/schemas/magic_route'
iam_description:
type: string
description: Description of role's permissions.
example: Administrative access to the entire Organization
readOnly: true
teams-devices_unique_client_id_input_request:
type: object
title: Unique Client ID
required:
- operating_system
- id
properties:
id:
type: string
description: List ID.
example: da3de859-8f6e-47ea-a2b5-b2433858471f
operating_system:
type: string
description: Operating System
enum:
- android
- ios
- chromeos
example: android
magic_components-schemas-tunnel_update_request:
type: object
properties:
description:
$ref: '#/components/schemas/magic_interconnect_components-schemas-description'
gre:
$ref: '#/components/schemas/magic_gre'
health_check:
$ref: '#/components/schemas/magic_schemas-health_check'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
mtu:
$ref: '#/components/schemas/magic_schemas-mtu'
stream_video_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
$ref: '#/components/schemas/stream_videos'
access_last_key_rotation_at:
type: string
format: date-time
description: The timestamp of the previous key rotation.
example: '2014-01-01T05:20:00.12345Z'
workers-kv_key_name_bulk:
type: string
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
zero-trust-gateway_provider_name:
type: string
description: The name of the provider. Usually Cloudflare.
example: Cloudflare
access_access_group_rule:
type: object
title: Access groups
description: Matches an Access group.
required:
- group
properties:
group:
type: object
required:
- id
properties:
id:
type: string
description: The ID of a previously created Access group.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
zero-trust-gateway_audit_ssh_settings_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_settings'
magic-transit_colo_result:
type: object
properties:
colo:
$ref: '#/components/schemas/magic-transit_colo'
error:
$ref: '#/components/schemas/magic-transit_error'
hops:
type: array
items:
$ref: '#/components/schemas/magic-transit_hop_result'
target_summary:
$ref: '#/components/schemas/magic-transit_target_summary'
traceroute_time_ms:
$ref: '#/components/schemas/magic-transit_traceroute_time_ms'
lists_item-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
$ref: '#/components/schemas/lists_item'
workers_domain:
type: object
properties:
environment:
$ref: '#/components/schemas/workers_schemas-environment'
hostname:
$ref: '#/components/schemas/workers_hostname'
id:
$ref: '#/components/schemas/workers_domain_identifier'
service:
$ref: '#/components/schemas/workers_schemas-service'
zone_id:
$ref: '#/components/schemas/workers_zone_identifier'
zone_name:
$ref: '#/components/schemas/workers_zone_name'
vectorize_index-get-vectors-by-id-response:
type: array
description: Array of vectors with matching ids.
example:
- id: some-vector-id
metadata:
another-key: another-value
customer-id: 442
values:
- 0.812
- 0.621
- 0.261
- id: other-vector-id
metadata:
another-key: with-a-value
customer-id: 2151
namespace: namespaced
values:
- 0.961
- 0.751
- 0.661
items:
type: object
properties:
id:
$ref: '#/components/schemas/vectorize_identifier'
metadata:
type: object
namespace:
type: string
nullable: true
values:
type: array
items:
type: number
magic-transit_packets_per_ttl:
type: integer
description: Number of packets sent at each TTL.
default: 3
minimum: 0
maximum: 10
magic-transit_target_summary:
type: object
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
aaa_token:
type: string
description: token in form of UUID
example: a313ba7d-3e46-4c0e-a408-08fafbc3816a
readOnly: true
maxLength: 36
access_bookmarks_components-schemas-name:
type: string
description: The name of the Bookmark application.
example: My Website
custom-pages_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/custom-pages_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/custom-pages_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/teams-devices_messages'
messages:
$ref: '#/components/schemas/teams-devices_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful.
enum:
- true
example: true
cloudforce-one_request-message-edit:
type: object
title: Request Message Editable Attributes
properties:
content:
$ref: '#/components/schemas/cloudforce-one_message-content'
lists_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
workers_namespace:
type: object
properties:
class:
readOnly: true
id:
readOnly: true
name:
readOnly: true
script:
readOnly: true
access_components-schemas-id_response:
allOf:
- $ref: '#/components/schemas/access_api-response-common'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/access_uuid'
zero-trust-gateway_body-scanning-settings:
type: object
description: DLP body scanning settings.
properties:
inspection_mode:
type: string
description: Set the inspection mode to either `deep` or `shallow`.
example: deep
access_approval_groups:
type: array
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/access_approval_group'
email_destination_address_response_single:
allOf:
- $ref: '#/components/schemas/email_api-response-single'
- properties:
result:
$ref: '#/components/schemas/email_addresses'
magic-transit_error:
type: string
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: ''
vectorize_index-dimensions:
type: integer
description: Specifies the number of dimensions for the index
example: 768
minimum: 1
maximum: 1536
teams-devices_os_version_input_request:
type: object
title: OS Version
required:
- operating_system
- version
- operator
properties:
operating_system:
type: string
description: Operating System
enum:
- windows
example: windows
operator:
type: string
description: Operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: 13.3.0
os_distro_name:
type: string
description: Operating System Distribution Name (linux only)
example: ubuntu
os_distro_revision:
type: string
description: Version of OS Distribution (linux only)
example: 11.3.1
os_version_extra:
type: string
description: Additional version data. For Mac or iOS, the Product Verison Extra. For Linux, the kernel release version. (Mac, iOS, and Linux only)
example: (a) or -1007
version:
type: string
description: Version of OS
example: 13.3.0
workers_api-response-single:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
tunnel_connection:
properties:
colo_name:
$ref: '#/components/schemas/tunnel_colo_name'
is_pending_reconnect:
$ref: '#/components/schemas/tunnel_is_pending_reconnect'
uuid:
$ref: '#/components/schemas/tunnel_connection_id'
lists_bulk-operation-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
$ref: '#/components/schemas/lists_operation'
stream_direct_upload_request:
type: object
required:
- maxDurationSeconds
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
creator:
$ref: '#/components/schemas/stream_creator'
expiry:
type: string
format: date-time
description: The date and time after upload when videos will not be accepted.
default: Now + 30 minutes
example: '2021-01-02T02:20:00Z'
maxDurationSeconds:
$ref: '#/components/schemas/stream_maxDurationSeconds'
meta:
$ref: '#/components/schemas/stream_media_metadata'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
watermark:
$ref: '#/components/schemas/stream_watermark_at_upload'
workers_uuid:
type: string
description: API Resource UUID tag.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
zero-trust-gateway_single_response_with_list_items:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
description:
$ref: '#/components/schemas/zero-trust-gateway_description'
id:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
items:
$ref: '#/components/schemas/zero-trust-gateway_items'
name:
$ref: '#/components/schemas/zero-trust-gateway_name'
type:
$ref: '#/components/schemas/zero-trust-gateway_type'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
tunnel_tunnel_response_token:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: string
example: eyJhIjoiNWFiNGU5Z...
images_api-response-collection-v2:
allOf:
- $ref: '#/components/schemas/images_api-response-common'
- properties:
result:
type: object
properties:
continuation_token:
$ref: '#/components/schemas/images_images_list_continuation_token'
type: object
zero-trust-gateway_rules:
type: object
properties:
action:
$ref: '#/components/schemas/zero-trust-gateway_action'
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
deleted_at:
$ref: '#/components/schemas/zero-trust-gateway_deleted_at'
description:
$ref: '#/components/schemas/zero-trust-gateway_schemas-description'
device_posture:
$ref: '#/components/schemas/zero-trust-gateway_device_posture'
enabled:
$ref: '#/components/schemas/zero-trust-gateway_enabled'
filters:
$ref: '#/components/schemas/zero-trust-gateway_filters'
id:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
identity:
$ref: '#/components/schemas/zero-trust-gateway_identity'
name:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-name'
precedence:
$ref: '#/components/schemas/zero-trust-gateway_precedence'
rule_settings:
$ref: '#/components/schemas/zero-trust-gateway_rule-settings'
schedule:
$ref: '#/components/schemas/zero-trust-gateway_schedule'
traffic:
$ref: '#/components/schemas/zero-trust-gateway_traffic'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
tunnel_remote_config:
type: boolean
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
tunnel_features:
type: array
description: Features enabled for the Cloudflare Tunnel.
items:
type: string
example: ha-origin
load-balancing_disabled_at:
type: string
format: date-time
description: This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
readOnly: true
workers_batch_size:
type: number
example: 10
intel_create_feed:
example:
description: example feed description
name: example_feed_1
properties:
description:
$ref: '#/components/schemas/intel_description'
name:
$ref: '#/components/schemas/intel_name'
dlp_create_custom_profiles:
required:
- profiles
properties:
profiles:
type: array
items:
$ref: '#/components/schemas/dlp_new_custom_profile'
required:
- name
- entries
dns-custom-nameservers_CustomNS:
title: Custom NS
description: A single account custom nameserver.
required:
- dns_records
- ns_name
- status
- zone_tag
properties:
dns_records:
type: array
description: A and AAAA records associated with the nameserver.
items:
properties:
type:
type: string
description: DNS record type.
enum:
- A
- AAAA
example: A
value:
type: string
description: DNS record contents (an IPv4 or IPv6 address).
example: 1.1.1.1
ns_name:
$ref: '#/components/schemas/dns-custom-nameservers_ns_name'
ns_set:
$ref: '#/components/schemas/dns-custom-nameservers_ns_set'
status:
type: string
description: Verification status of the nameserver.
enum:
- moved
- pending
- verified
example: verified
deprecated: true
zone_tag:
$ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier'
legacy-jhs_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
magic-visibility_pcaps_colo_name:
type: string
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
dlp_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
turnstile_domains:
type: array
example:
- 203.0.113.1
- cloudflare.com
- blog.example.com
maxLength: 10
items:
type: string
description: 'Hosts as a hostname or IPv4/IPv6 address represented by strings. The
widget will only work on these domains, and their subdomains.
'
example: 203.0.113.1
workers_renamed_name:
type: string
example: renamed-example-queue
intel_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/intel_domain-history'
dns-firewall_dns_firewall_single_response:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-single'
- properties:
result:
$ref: '#/components/schemas/dns-firewall_dns-firewall'
dns-custom-nameservers_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
teams-devices_kolide_config_request:
type: object
title: Kolide Config
required:
- client_id
- client_secret
properties:
client_id:
type: string
description: The Kolide client ID.
example: example client id
client_secret:
type: string
description: The Kolide client secret.
example: example client secret
aaa_sensitive_id_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/aaa_token'
tunnel_legacy-tunnel-response-single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/tunnel_argo-tunnel'
access_policies_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_policies'
intel_id:
type: integer
description: The unique identifier for the indicator feed
aaa_pagerduty:
type: object
properties:
id:
$ref: '#/components/schemas/aaa_uuid'
name:
$ref: '#/components/schemas/aaa_name'
magic_components-schemas-modified_tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_interconnects:
type: array
items:
$ref: '#/components/schemas/magic_interconnect'
magic_customer_gre_endpoint:
type: string
description: The IP address assigned to the customer side of the GRE tunnel.
example: 203.0.113.1
stream_language_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_captions'
pages_project-response:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
$ref: '#/components/schemas/pages_projects'
registrar-api_privacy:
type: boolean
description: Privacy option controls redacting WHOIS information.
example: true
addressing_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/addressing_messages'
messages:
$ref: '#/components/schemas/addressing_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
legacy-jhs_notes:
type: string
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.
access_azureAD:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
conditional_access_enabled:
type: boolean
description: Should Cloudflare try to load authentication contexts from your account
directory_id:
type: string
description: Your Azure directory uuid
example:
prompt:
type: string
description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.
enum:
- login
- select_account
- none
support_groups:
type: boolean
description: Should Cloudflare try to load groups from your account
type: object
title: Azure AD
intel_collection_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-collection'
- properties:
result:
type: array
items:
properties:
additional_information:
$ref: '#/components/schemas/intel_additional_information'
application:
$ref: '#/components/schemas/intel_application'
content_categories:
$ref: '#/components/schemas/intel_content_categories'
domain:
$ref: '#/components/schemas/intel_domain_name'
inherited_content_categories:
$ref: '#/components/schemas/intel_inherited_content_categories'
inherited_from:
$ref: '#/components/schemas/intel_inherited_from'
inherited_risk_types:
$ref: '#/components/schemas/intel_inherited_risk_types'
popularity_rank:
$ref: '#/components/schemas/intel_popularity_rank'
risk_score:
$ref: '#/components/schemas/intel_risk_score'
risk_types:
$ref: '#/components/schemas/intel_risk_types'
lists_api-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
type: object
iam_account:
type: object
required:
- id
- name
properties:
created_on:
type: string
format: date-time
description: Timestamp for the creation of the account
example: '2014-03-01T12:21:02.0000Z'
readOnly: true
id:
$ref: '#/components/schemas/iam_common_components-schemas-identifier'
name:
type: string
description: Account name
example: Demo Account
maxLength: 100
settings:
type: object
description: Account settings
properties:
default_nameservers:
type: string
description: 'Specifies the default nameservers to be used for new zones added to this account.
- `cloudflare.standard` for Cloudflare-branded nameservers
- `custom.account` for account custom nameservers
- `custom.tenant` for tenant custom nameservers
See [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)
for more information.'
enum:
- cloudflare.standard
- custom.account
- custom.tenant
default: cloudflare.standard
enforce_twofactor:
type: boolean
description: 'Indicates whether membership in this account requires that
Two-Factor Authentication is enabled'
default: false
use_account_custom_ns_by_default:
type: boolean
description: 'Indicates whether new zones should use the account-level custom
nameservers by default.
Deprecated in favor of `default_nameservers`.'
default: false
deprecated: true
legacy-jhs_common_components-schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
access_purpose_justification_prompt:
type: string
description: A custom message that will appear on the purpose justification screen.
example: Please enter a justification for entering this protected domain.
workers-kv_metadata:
type: string
description: Arbitrary JSON to be associated with a key/value pair.
example: '{"someMetadataKey": "someMetadataValue"}'
rum_rule-response-single:
allOf:
- $ref: '#/components/schemas/rum_api-response-single'
- properties:
result:
$ref: '#/components/schemas/rum_rule'
stream_update_output_request:
required:
- enabled
properties:
enabled:
$ref: '#/components/schemas/stream_output_enabled'
teams-devices_devices:
type: object
properties:
created:
$ref: '#/components/schemas/teams-devices_created'
deleted:
$ref: '#/components/schemas/teams-devices_deleted'
device_type:
$ref: '#/components/schemas/teams-devices_platform'
id:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
ip:
$ref: '#/components/schemas/teams-devices_ip'
key:
$ref: '#/components/schemas/teams-devices_key'
last_seen:
$ref: '#/components/schemas/teams-devices_last_seen'
mac_address:
$ref: '#/components/schemas/teams-devices_mac_address'
manufacturer:
$ref: '#/components/schemas/teams-devices_manufacturer'
model:
$ref: '#/components/schemas/teams-devices_model'
name:
$ref: '#/components/schemas/teams-devices_schemas-name'
os_distro_name:
$ref: '#/components/schemas/teams-devices_os_distro_name'
os_distro_revision:
$ref: '#/components/schemas/teams-devices_os_distro_revision'
os_version:
$ref: '#/components/schemas/teams-devices_os_version'
os_version_extra:
$ref: '#/components/schemas/teams-devices_os_version_extra'
revoked_at:
$ref: '#/components/schemas/teams-devices_revoked_at'
serial_number:
$ref: '#/components/schemas/teams-devices_serial_number'
updated:
$ref: '#/components/schemas/teams-devices_updated'
user:
$ref: '#/components/schemas/teams-devices_user'
version:
$ref: '#/components/schemas/teams-devices_version'
rulesets_FailureResponse:
type: object
title: Failure response
description: A failure response object.
required:
- result
- success
- errors
- messages
properties:
errors:
$ref: '#/components/schemas/rulesets_Errors'
messages:
$ref: '#/components/schemas/rulesets_Messages'
result:
title: Result
description: A result.
enum:
- null
success:
type: boolean
title: Success
description: Whether the API call was successful.
enum:
- false
dlp_validate_pattern:
type: object
title: Pattern
description: A request to validate a pattern
required:
- regex
properties:
regex:
type: string
description: The regex pattern.
example: ^4[0-9]{6,}$
r2_v4_response:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/r2_errors'
messages:
$ref: '#/components/schemas/r2_messages'
result:
type: object
success:
type: boolean
description: Whether the API call was successful
enum:
- true
digital-experience-monitoring_sort_by:
type: string
description: Dimension to sort results by
enum:
- colo
- device_id
- mode
- platform
- status
- timestamp
- version
default: timestamp
magic-transit_node_result:
type: object
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/magic-transit_asn'
ip:
$ref: '#/components/schemas/magic-transit_ip'
labels:
$ref: '#/components/schemas/magic-transit_labels'
max_rtt_ms:
$ref: '#/components/schemas/magic-transit_max_rtt_ms'
mean_rtt_ms:
$ref: '#/components/schemas/magic-transit_mean_rtt_ms'
min_rtt_ms:
$ref: '#/components/schemas/magic-transit_min_rtt_ms'
name:
$ref: '#/components/schemas/magic-transit_name'
packet_count:
$ref: '#/components/schemas/magic-transit_packet_count'
std_dev_rtt_ms:
$ref: '#/components/schemas/magic-transit_std_dev_rtt_ms'
aaa_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: object
example:
email:
eligible: true
ready: true
type: email
pages_new-project-response:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
type: object
aaa_name:
type: string
description: The name of the pagerduty service.
example: My PagerDuty Service
teams-devices_client_certificate_input_request:
type: object
title: Client Certificate
required:
- certificate_id
- cn
properties:
certificate_id:
type: string
description: UUID of Cloudflare managed certificate.
example: b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30
maxLength: 36
cn:
type: string
description: Common Name that is protected by the certificate
example: example.com
images_image_variant_schemas_metadata:
type: string
description: What EXIF data should be preserved in the output image.
enum:
- keep
- copyright
- none
example: none
tls-certificates-and-hostnames_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
rum_api-response-collection:
allOf:
- $ref: '#/components/schemas/rum_api-response-common'
type: object
lists_lists-async-response:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
type: object
properties:
operation_id:
$ref: '#/components/schemas/lists_operation_id'
addressing_bgp_on_demand:
type: object
properties:
advertised:
$ref: '#/components/schemas/addressing_advertised'
advertised_modified_at:
$ref: '#/components/schemas/addressing_modified_at_nullable'
on_demand_enabled:
$ref: '#/components/schemas/addressing_on_demand_enabled'
on_demand_locked:
$ref: '#/components/schemas/addressing_on_demand_locked'
lists_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 (-).
required:
- url_hostname
properties:
url_hostname:
type: string
example: example.com
dns-custom-nameservers_identifier:
type: string
description: Account identifier tag.
example: 372e67954025e0ba6aaa6d586b9e0b59
readOnly: true
maxLength: 32
custom-pages_custom_pages_response_single:
allOf:
- $ref: '#/components/schemas/custom-pages_api-response-single'
- properties:
result:
type: object
teams-devices_tls_config_response:
type: object
description: The Managed Network TLS Config Response.
required:
- tls_sockaddr
properties:
sha256:
type: string
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
tls_sockaddr:
type: string
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
dlp_integration_profile:
type: object
title: Integration profile
properties:
created_at:
$ref: '#/components/schemas/dlp_timestamp'
description:
type: string
description: The description of the profile.
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_integration_entry'
id:
$ref: '#/components/schemas/dlp_profile_id'
name:
type: string
description: The name of the profile.
example: 'MIP Sensitivity Labels: Profile 1'
type:
type: string
description: The type of the profile.
enum:
- integration
example: integration
updated_at:
$ref: '#/components/schemas/dlp_timestamp'
magic_tunnel_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_gre_tunnel:
type: object
access_keys_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- $ref: '#/components/schemas/access_key_config'
dns-firewall_dns_firewall_ips:
type: array
example:
- 203.0.113.1
- 203.0.113.254
- 2001:DB8:AB::CF
- 2001:DB8:CD::CF
items:
anyOf:
- type: string
format: ipv4
description: Cloudflare-assigned DNS IPv4 Address.
example: 203.0.113.1
- type: string
format: ipv6
description: Cloudflare-assigned DNS IPv6 Address.
example: 2001:DB8:ab::CF
zero-trust-gateway_count:
type: number
description: The number of items in the list.
example: 20
readOnly: true
logpush_error_message:
type: string
format: date-time
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.'
nullable: true
teams-devices_fallback_domain:
type: object
required:
- suffix
properties:
description:
type: string
description: A description of the fallback domain, displayed in the client UI.
example: Domain bypass for local development
maxLength: 100
dns_server:
type: array
description: A list of IP addresses to handle domain resolution.
items: {}
suffix:
type: string
description: The domain suffix to match when resolving locally.
example: example.com
magic_interconnect_components-schemas-description:
type: string
description: An optional description of the interconnect.
example: Tunnel for Interconnect to ORD
rulesets_AccountId:
type: string
title: ID
description: The unique ID of the account.
example: abf9b32d38c5f572afde3336ec0ce302
pattern: ^[0-9a-f]{32}$
rulesets_ExecuteSensitivityLevel:
type: string
title: Sensitivity level
enum:
- default
- medium
- low
- eoff
stream_watermark_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_watermarks'
teams-devices_checkDisks:
type: array
description: List of volume names to be checked for encryption.
example:
- C
- D
- G
items:
type: string
stream_output:
properties:
enabled:
$ref: '#/components/schemas/stream_output_enabled'
streamKey:
$ref: '#/components/schemas/stream_output_streamKey'
uid:
$ref: '#/components/schemas/stream_output_identifier'
url:
$ref: '#/components/schemas/stream_output_url'
access_email_rule:
type: object
title: Email
description: Matches a specific email.
required:
- email
properties:
email:
type: object
required:
- email
properties:
email:
type: string
format: email
description: The email of the user.
example: test@example.com
logpush_last_complete:
type: string
format: date-time
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.
nullable: true
registrar-api_expires_at:
type: string
format: date-time
description: Shows when domain name registration expires.
example: '2019-08-28T23:59:59Z'
load-balancing_monitor-response-single:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/load-balancing_monitor'
addressing_single_response_bgp:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
zero-trust-gateway_audit_ssh_settings_components-schemas-uuid:
type: string
description: Seed ID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
stream_readyToStream:
type: boolean
description: Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
example: true
teams-devices_last_seen:
type: string
format: date-time
description: When the device last connected to Cloudflare services.
example: '2017-06-14T00:00:00Z'
intel-sinkholes_sinkhole_item:
example:
account_tag: 233f45e61fd1f7e21e1e154ede4q2859
created_on: '2023-05-12T12:21:56.777653Z'
description: user specified description 1
id: 1
modified_on: '2023-06-18T03:13:34.123321Z'
name: sinkhole_1
r2_bucket: my_bucket
r2_id:
properties:
account_tag:
type: string
description: The account tag that owns this sinkhole
created_on:
type: string
format: date-time
description: The date and time when the sinkhole was created
id:
$ref: '#/components/schemas/intel-sinkholes_id'
modified_on:
type: string
format: date-time
description: The date and time when the sinkhole was last modified
name:
$ref: '#/components/schemas/intel-sinkholes_name'
r2_bucket:
type: string
description: The name of the R2 bucket to store results
r2_id:
type: string
description: The id of the R2 instance
access_associated_hostnames:
type: array
description: The hostnames of the applications that will use this certificate.
items:
type: string
description: A fully-qualified domain name (FQDN).
example: admin.example.com
access_ssh_props:
allOf:
- $ref: '#/components/schemas/access_self_hosted_props'
- properties:
type:
type: string
description: The application type.
example: ssh
d1_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/d1_messages'
messages:
$ref: '#/components/schemas/d1_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
load-balancing_path:
type: string
description: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
default: /
example: /health
teams-devices_device-dex-test-schemas-interval:
type: string
description: How often the test will run.
example: 30m
dns-custom-nameservers_CustomNSInput:
title: Custom NS Input
required:
- ns_name
properties:
ns_name:
$ref: '#/components/schemas/dns-custom-nameservers_ns_name'
ns_set:
$ref: '#/components/schemas/dns-custom-nameservers_ns_set'
r2_sippy:
type: object
properties:
destination:
type: object
description: Details about the configured destination bucket
properties:
accessKeyId:
type: string
description: 'ID of the Cloudflare API token used when writing objects to this
bucket
'
account:
type: string
bucket:
type: string
description: Name of the bucket on the provider
provider:
type: string
enum:
- r2
enabled:
type: boolean
description: State of Sippy for this bucket
source:
type: object
description: Details about the configured source bucket
properties:
bucket:
type: string
description: Name of the bucket on the provider
provider:
type: string
enum:
- aws
- gcs
region:
type: string
description: Region where the bucket resides (AWS only)
nullable: true
dlp_V4ResponseError:
type: object
required:
- success
- errors
- messages
properties:
errors:
type: array
items:
$ref: '#/components/schemas/dlp_V4ResponseMessage'
messages:
type: array
items:
$ref: '#/components/schemas/dlp_V4ResponseMessage'
result:
type: object
nullable: true
success:
type: boolean
registrar-api_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:
type: boolean
description: Indicates if cancellation is still possible.
example: true
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.
intel_indicator_feed_item:
example:
created_on: '2023-05-12T12:21:56.777653Z'
description: example feed description
id: 1
modified_on: '2023-06-18T03:13:34.123321Z'
name: example_feed_1
properties:
created_on:
type: string
format: date-time
description: The date and time when the data entry was created
description:
$ref: '#/components/schemas/intel_description'
id:
$ref: '#/components/schemas/intel_id'
modified_on:
type: string
format: date-time
description: The date and time when the data entry was last modified
name:
$ref: '#/components/schemas/intel_name'
access_certificates:
type: object
properties:
associated_hostnames:
$ref: '#/components/schemas/access_associated_hostnames'
created_at:
$ref: '#/components/schemas/access_timestamp'
expires_on:
$ref: '#/components/schemas/access_timestamp'
fingerprint:
$ref: '#/components/schemas/access_fingerprint'
id:
description: The ID of the application that will use this certificate.
name:
$ref: '#/components/schemas/access_certificates_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
aaa_webhooks:
type: object
properties:
created_at:
$ref: '#/components/schemas/aaa_created_at'
id:
$ref: '#/components/schemas/aaa_webhook-id'
last_failure:
$ref: '#/components/schemas/aaa_last_failure'
last_success:
$ref: '#/components/schemas/aaa_last_success'
name:
$ref: '#/components/schemas/aaa_components-schemas-name'
secret:
$ref: '#/components/schemas/aaa_secret'
type:
$ref: '#/components/schemas/aaa_components-schemas-type'
url:
$ref: '#/components/schemas/aaa_url'
workers_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/workers_messages'
messages:
$ref: '#/components/schemas/workers_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
aaa_api-response-collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/aaa_result_info'
type: object
magic_colo_region:
type: string
description: Scope colo region.
example: APAC
stream_errorReasonText:
type: string
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.
magic-visibility_pcaps_ownership_response:
type: object
required:
- id
- status
- submitted
- destination_conf
- filename
properties:
destination_conf:
$ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
filename:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_challenge'
id:
type: string
description: The bucket ID associated with the packet captures API.
example: 9883874ecac311ec8475433579a6bf5f
minLength: 32
maxLength: 32
status:
type: string
description: The status of the ownership challenge. Can be pending, success or failed.
enum:
- pending
- success
- failed
example: success
submitted:
type: string
description: The RFC 3339 timestamp when the bucket was added to packet captures API.
example: '2020-01-01T08:00:00Z'
validated:
type: string
description: The RFC 3339 timestamp when the bucket was validated.
example: '2020-01-01T08:00:00Z'
teams-devices_tanium_config_request:
type: object
title: Tanium Config
required:
- api_url
- client_secret
properties:
access_client_id:
type: string
description: If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`
example: 88bf3b6d86161464f6509f7219099e57.access
access_client_secret:
type: string
description: If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`
example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
api_url:
type: string
description: The Tanium API URL.
example: https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql
client_secret:
type: string
description: The Tanium client secret.
example: example client secret
zero-trust-gateway_enabled:
type: boolean
description: True if the rule is enabled.
example: true
pages_projects:
type: object
properties:
build_config:
$ref: '#/components/schemas/pages_build_config'
canonical_deployment:
$ref: '#/components/schemas/pages_deployments'
created_on:
type: string
format: date-time
description: When the project was created.
example: '2017-01-01T00:00:00Z'
readOnly: true
deployment_configs:
$ref: '#/components/schemas/pages_deployment_configs'
domains:
type: array
description: A list of associated custom domains for the project.
example:
- customdomain.com
- customdomain.org
readOnly: true
items: {}
id:
type: string
description: Id of the project.
example: 7b162ea7-7367-4d67-bcde-1160995d5
readOnly: true
latest_deployment:
$ref: '#/components/schemas/pages_deployments'
name:
type: string
description: Name of the project.
example: NextJS Blog
production_branch:
type: string
description: Production branch of the project. Used to identify production deployments.
example: main
source:
readOnly: true
subdomain:
type: string
description: The Cloudflare subdomain associated with the project.
example: helloworld.pages.dev
readOnly: true
images_images_stats_current:
type: number
description: Cloudflare Images current usage.
example: 1000
readOnly: true
bill-subs-api_name:
type: string
description: The domain name
example: example.com
readOnly: true
maxLength: 253
pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
stream_liveInput:
type: string
description: The live input ID used to upload a video with Stream Live.
example: fc0a8dc887b16759bfd9ad922230a014
maxLength: 32
addressing_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
rulesets_RulesetResponse:
allOf:
- $ref: '#/components/schemas/rulesets_Ruleset'
- required:
- name
- kind
- phase
- rules
properties:
rules:
$ref: '#/components/schemas/rulesets_RulesResponse'
access_seats_definition:
type: array
items:
$ref: '#/components/schemas/access_seat'
required:
- seat_uid
- gateway_seat
- access_seat
dlp_DatasetArray:
type: array
items:
$ref: '#/components/schemas/dlp_Dataset'
intel_page:
type: number
description: Current page within paginated list of results.
example: 1
teams-devices_device-dex-test-schemas-data:
type: object
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:
type: string
description: The desired endpoint to test.
example: https://dash.cloudflare.com
kind:
type: string
description: The type of test.
example: http
method:
type: string
description: The HTTP request method type.
example: GET
iam_member_components-schemas-name:
type: string
description: Member Name.
example: John Smith
nullable: true
maxLength: 100
legacy-jhs_response_collection:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-collection'
- type: object
properties:
result:
type: array
items:
type: object
magic-visibility_mnm_config_single_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/magic-visibility_mnm_config'
legacy-jhs_api-response-single:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
nullable: true
type: object
calls_secret:
type: string
description: Bearer token to use the Calls API.
example: 66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4
minLength: 64
maxLength: 64
tunnel_tunnel_types:
type: string
description: The types of tunnels to filter separated by a comma.
example: cfd_tunnel,warp_connector
calls_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/calls_messages'
messages:
$ref: '#/components/schemas/calls_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
addressing_create_binding_request:
type: object
properties:
cidr:
$ref: '#/components/schemas/addressing_cidr'
service_id:
$ref: '#/components/schemas/addressing_service_identifier'
dlp_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
workers-kv_expiration:
type: number
description: The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
example: 1578435000
workers_subdomain-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
name:
readOnly: true
dlp_get_settings_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
required:
- public_key
properties:
public_key:
type: string
example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=
nullable: true
teams-devices_service_mode_v2:
type: object
properties:
mode:
type: string
description: The mode to run the WARP client under.
example: proxy
port:
type: number
description: The port number when used with proxy mode.
example: 3000
dlp_DatasetCreation:
type: object
required:
- version
- max_cells
- dataset
properties:
dataset:
$ref: '#/components/schemas/dlp_Dataset'
max_cells:
type: integer
format: int64
minimum: 0
secret:
type: string
format: password
description: 'The secret to use for Exact Data Match datasets. This is not present in
Custom Wordlists.'
version:
type: integer
format: int64
description: The version to use when uploading the dataset.
hyperdrive_create-update-hyperdrive-config:
allOf:
- $ref: '#/components/schemas/hyperdrive_hyperdrive'
type: object
required:
- name
- origin
properties:
origin:
$ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-password'
magic-visibility_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
workers_placement_config:
type: object
properties:
mode:
type: string
description: Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement). Only `"smart"` is currently supported
enum:
- smart
stream_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
teams-devices_dex-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
intel_passive-dns-by-ip:
properties:
count:
type: number
description: Total results returned based on your search parameters.
example: 1
page:
type: number
description: Current page within paginated list of results.
example: 1
per_page:
type: number
description: Number of results per page of results.
example: 20
reverse_records:
type: array
description: Reverse DNS look-ups observed during the time period.
items:
type: object
properties:
first_seen:
type: string
format: date
description: First seen date of the DNS record during the time period.
example: '2021-04-01'
hostname:
description: Hostname that the IP was observed resolving to.
last_seen:
type: string
format: date
description: Last seen date of the DNS record during the time period.
example: '2021-04-30'
access_settings:
type: object
title: Hostname Settings
required:
- hostname
- china_network
- client_certificate_forwarding
properties:
china_network:
type: boolean
description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
example: false
client_certificate_forwarding:
type: boolean
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
hostname:
type: string
description: The hostname that these settings apply to.
example: admin.example.com
dns-custom-nameservers_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
workers_tags:
type: array
description: Tags to help you manage your Workers
items:
$ref: '#/components/schemas/workers_tag'
stream_notificationUrl:
type: string
format: uri
description: The URL where webhooks will be sent.
example: https://example.com
access_service_token_rule:
type: object
title: Service Token
description: Matches a specific Access Service Token
required:
- service_token
properties:
service_token:
type: object
required:
- token_id
properties:
token_id:
type: string
description: The ID of a Service Token.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
access_users:
type: object
properties:
access_seat:
$ref: '#/components/schemas/access_schemas-access_seat'
active_device_count:
$ref: '#/components/schemas/access_active_device_count'
created_at:
$ref: '#/components/schemas/access_timestamp'
email:
$ref: '#/components/schemas/access_schemas-email'
gateway_seat:
$ref: '#/components/schemas/access_schemas-gateway_seat'
id:
$ref: '#/components/schemas/access_uuid'
last_successful_login:
$ref: '#/components/schemas/access_last_successful_login'
name:
$ref: '#/components/schemas/access_users_components-schemas-name'
seat_uid:
$ref: '#/components/schemas/access_seat_uid'
uid:
$ref: '#/components/schemas/access_uid'
updated_at:
$ref: '#/components/schemas/access_timestamp'
digital-experience-monitoring_traceroute_test_result_network_path_response:
type: object
required:
- resultId
- time_start
- hops
properties:
deviceName:
type: string
description: name of the device associated with this network path response
hops:
type: array
description: an array of the hops taken by the device to reach the end destination
items:
type: object
required:
- ttl
properties:
asn:
type: integer
nullable: true
aso:
type: string
nullable: true
ipAddress:
type: string
nullable: true
location:
type: object
nullable: true
properties:
city:
type: string
nullable: true
state:
type: string
nullable: true
zip:
type: string
nullable: true
mile:
type: string
enum:
- client-to-app
- client-to-cf-egress
- client-to-cf-ingress
- client-to-isp
nullable: true
name:
type: string
nullable: true
packetLossPct:
type: number
format: float
nullable: true
rttMs:
type: integer
nullable: true
ttl:
type: integer
resultId:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
testId:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
testName:
type: string
description: name of the tracroute test
time_start:
type: string
description: date time of this traceroute test
example: 2023-07-16 15:00:00+00:00
access_schemas-gateway_seat:
type: boolean
description: True if the user has logged into the WARP client.
example: false
intel_update_feed:
properties:
file_id:
type: integer
description: Feed id
example: 1
filename:
type: string
description: Name of the file unified in our system
example: snapshot_file.unified
status:
type: string
description: Current status of upload, should be unified
example: unified
email_created:
type: string
format: date-time
description: The date and time the destination address has been created.
example: '2014-01-02T02:20:00Z'
readOnly: true
registrar-api_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/registrar-api_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/registrar-api_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
images_image_variant_simple_response:
allOf:
- $ref: '#/components/schemas/images_api-response-single'
- properties:
result:
$ref: '#/components/schemas/images_image_variant_response'
secondary-dns_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
legacy-jhs_ipv6_configuration:
title: An IPv6 address 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:
type: string
description: The IPv6 address to match.
example: 2001:DB8:100::CF
secondary-dns_tsig:
type: object
required:
- id
- name
- secret
- algo
properties:
algo:
$ref: '#/components/schemas/secondary-dns_algo'
id:
$ref: '#/components/schemas/secondary-dns_schemas-identifier'
name:
$ref: '#/components/schemas/secondary-dns_schemas-name'
secret:
$ref: '#/components/schemas/secondary-dns_secret'
lists_name:
type: string
description: An informative name for the list. Use this name in filter and rule expressions.
example: list1
maxLength: 50
pattern: ^[a-zA-Z0-9_]+$
magic-visibility_mnm_config:
type: object
required:
- name
- default_sampling
- router_ips
properties:
default_sampling:
$ref: '#/components/schemas/magic-visibility_mnm_config_default_sampling'
name:
$ref: '#/components/schemas/magic-visibility_mnm_config_name'
router_ips:
$ref: '#/components/schemas/magic-visibility_mnm_config_router_ips'
r2_messages:
type: array
items:
type: string
access_google:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
type: object
title: Google
magic_lan_dhcp_server:
type: object
properties:
dhcp_pool_end:
$ref: '#/components/schemas/magic_ip-address'
dhcp_pool_start:
$ref: '#/components/schemas/magic_ip-address'
dns_server:
$ref: '#/components/schemas/magic_ip-address'
reservations:
type: object
description: Mapping of MAC addresses to IP addresses
example:
00:11:22:33:44:55: 192.0.2.100
AA:BB:CC:DD:EE:FF: 192.168.1.101
stream_live_input_object_without_url:
properties:
created:
$ref: '#/components/schemas/stream_live_input_created'
deleteRecordingAfterDays:
$ref: '#/components/schemas/stream_live_input_recording_deletion'
meta:
$ref: '#/components/schemas/stream_live_input_metadata'
modified:
$ref: '#/components/schemas/stream_live_input_modified'
uid:
$ref: '#/components/schemas/stream_live_input_identifier'
dns-firewall_dns_firewall_response_collection:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dns-firewall_dns-firewall'
magic_port:
type: integer
example: 1
access_schemas-domain:
type: string
description: The domain of the Bookmark application.
example: example.com
security-center_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
digital-experience-monitoring_test_stat_pct_over_time:
type: object
required:
- slots
properties:
avg:
type: number
format: float
description: average observed in the time period
nullable: true
max:
type: number
format: float
description: highest observed in the time period
nullable: true
min:
type: number
format: float
description: lowest observed in the time period
nullable: true
slots:
type: array
items:
type: object
required:
- timestamp
- value
properties:
timestamp:
type: string
example: 2023-07-16 15:00:00+00:00
value:
type: number
format: float
stream_live_input_recording_mode:
type: string
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
default: 'off'
example: automatic
digital-experience-monitoring_tests_response:
type: object
required:
- overviewMetrics
- tests
properties:
overviewMetrics:
type: object
required:
- testsTotal
properties:
avgTracerouteAvailabilityPct:
type: number
format: float
description: percentage availability for all traceroutes results in response
nullable: true
testsTotal:
type: integer
description: number of tests.
tests:
type: array
description: array of test results objects.
items:
type: object
required:
- id
- name
- kind
- interval
- enabled
- description
- updated
- created
- host
properties:
created:
type: string
description: date the test was created.
description:
type: string
description: the test description defined during configuration
enabled:
type: boolean
description: if true, then the test will run on targeted devices. Else, the test will not run.
host:
type: string
httpResults:
type: object
nullable: true
required:
- resourceFetchTime
properties:
resourceFetchTime:
$ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
httpResultsByColo:
type: array
items:
type: object
required:
- colo
- resourceFetchTime
properties:
colo:
type: string
description: Cloudflare colo
example: SJC
resourceFetchTime:
$ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
id:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
interval:
type: string
description: The interval at which the synthetic application test is set to run.
kind:
type: string
description: test type, http or traceroute
enum:
- http
- traceroute
method:
type: string
description: for HTTP, the method to use when running the test
name:
type: string
description: name given to this test
tracerouteResults:
type: object
nullable: true
required:
- roundTripTime
properties:
roundTripTime:
$ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
tracerouteResultsByColo:
type: array
items:
type: object
required:
- colo
- roundTripTime
properties:
colo:
type: string
description: Cloudflare colo
example: SJC
roundTripTime:
$ref: '#/components/schemas/digital-experience-monitoring_timing_aggregates'
updated:
type: string
magic_customer_ipsec_endpoint:
type: string
description: The IP address assigned to the customer side of the IPsec tunnel.
example: 203.0.113.1
intel_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/intel_messages'
messages:
$ref: '#/components/schemas/intel_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic-visibility_mnm_config_default_sampling:
type: number
description: Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.
default: 1
minimum: 1
magic_wan_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_wan:
$ref: '#/components/schemas/magic_wan'
access_email:
type: string
format: email
description: The email address of the authenticating user.
example: user@example.com
stream_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/stream_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/stream_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
cloudforce-one_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/cloudforce-one_messages'
messages:
$ref: '#/components/schemas/cloudforce-one_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
teams-devices_crowdstrike_input_request:
type: object
title: Crowdstrike S2S Input
required:
- connection_id
properties:
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
last_seen:
type: string
description: For more details on last seen, please refer to the Crowdstrike documentation.
example: '2023-07-20T23:16:32Z'
operator:
type: string
description: Operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
os:
type: string
description: Os Version
example: 13.3.0
overall:
type: string
description: overall
example: 90
sensor_config:
type: string
description: SensorConfig
example: 90
state:
type: string
description: For more details on state, please refer to the Crowdstrike documentation.
enum:
- online
- offline
- unknown
example: online
version:
type: string
description: Version
example: 13.3.0
versionOperator:
type: string
description: Version Operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
stream_signing_key_created:
type: string
format: date-time
description: The date and time a signing key was created.
example: '2014-01-02T02:20:00Z'
intel_phishing-url-info:
properties:
categorizations:
type: array
description: List of categorizations applied to this submission.
items:
type: object
properties:
category:
type: string
description: Name of the category applied.
example: PHISHING
verification_status:
type: string
description: Result of human review for this categorization.
example: confirmed
model_results:
type: array
description: List of model results for completed scans.
items:
type: object
properties:
model_name:
type: string
description: Name of the model.
example: MACHINE_LEARNING_v2
model_score:
type: number
description: Score output by the model for this submission.
example: 0.024
rule_matches:
type: array
description: List of signatures that matched against site content found when crawling the URL.
items:
type: object
properties:
banning:
type: boolean
description: For internal use.
blocking:
type: boolean
description: For internal use.
description:
type: string
description: Description of the signature that matched.
example: Match frequently used social followers phishing kit
name:
type: string
description: Name of the signature that matched.
example: phishkit.social_followers
scan_status:
type: object
description: Status of the most recent scan found.
properties:
last_processed:
type: string
description: Timestamp of when the submission was processed.
example: Wed, 26 Oct 2022 16:04:51 GMT
scan_complete:
type: boolean
description: For internal use.
status_code:
type: integer
description: Status code that the crawler received when loading the submitted URL.
submission_id:
type: integer
description: ID of the most recent submission.
screenshot_download_signature:
type: string
description: For internal use.
screenshot_path:
type: string
description: For internal use.
url:
type: string
description: URL that was submitted.
example: https://www.cloudflare.com
workers_kv_namespace_binding:
type: object
required:
- name
- type
- namespace_id
properties:
name:
$ref: '#/components/schemas/workers_binding_name'
namespace_id:
$ref: '#/components/schemas/workers_namespace_identifier'
type:
type: string
description: The class of resource that the binding provides.
enum:
- kv_namespace
example: kv_namespace
digital-experience-monitoring_traceroute_test_network_path_response:
type: object
required:
- id
properties:
deviceName:
type: string
id:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
interval:
type: string
description: The interval at which the Traceroute synthetic application test is set to run.
example: 0h5m0s
kind:
enum:
- traceroute
name:
type: string
networkPath:
type: object
nullable: true
required:
- slots
properties:
sampling:
type: object
description: Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.
nullable: true
required:
- value
- unit
properties:
unit:
enum:
- hours
value:
type: integer
slots:
type: array
items:
type: object
required:
- id
- timestamp
- clientToAppRttMs
- clientToCfIngressRttMs
- clientToCfEgressRttMs
properties:
clientToAppRttMs:
type: integer
description: Round trip time in ms of the client to app mile
nullable: true
clientToCfEgressRttMs:
type: integer
description: Round trip time in ms of the client to Cloudflare egress mile
nullable: true
clientToCfIngressRttMs:
type: integer
description: Round trip time in ms of the client to Cloudflare ingress mile
nullable: true
clientToIspRttMs:
type: integer
description: Round trip time in ms of the client to ISP mile
nullable: true
id:
$ref: '#/components/schemas/digital-experience-monitoring_uuid'
timestamp:
type: string
example: 2023-07-16 15:00:00+00:00
url:
type: string
description: The host of the Traceroute synthetic application test
example: 1.1.1.1
stream_api-response-single:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
teams-devices_device-managed-networks:
type: object
properties:
config:
$ref: '#/components/schemas/teams-devices_schemas-config_response'
name:
$ref: '#/components/schemas/teams-devices_device-managed-networks_components-schemas-name'
network_id:
$ref: '#/components/schemas/teams-devices_uuid'
type:
$ref: '#/components/schemas/teams-devices_components-schemas-type'
tls-certificates-and-hostnames_schemas-certificates:
type: string
description: The uploaded root CA certificate.
example: '--BEGIN CERTIFICATE--
MIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE
--END CERTIFICATE--'
zero-trust-gateway_type:
type: string
description: The type of list.
enum:
- SERIAL
- URL
- DOMAIN
- EMAIL
- IP
example: SERIAL
load-balancing_weight:
type: number
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.
- `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin''s outstanding requests.
- `origin_steering.policy="least_connections"`: Use weight to scale the origin''s open connections.'
default: 1
example: 0.6
minimum: 0
maximum: 1
multipleOf: 0.01
access_access_seat:
type: boolean
description: True if the seat is part of Access.
example: false
access_seat:
type: object
required:
- seat_uid
- gateway_seat
- access_seat
properties:
access_seat:
$ref: '#/components/schemas/access_access_seat'
gateway_seat:
$ref: '#/components/schemas/access_gateway_seat'
seat_uid:
$ref: '#/components/schemas/access_identifier'
bill-subs-api_billing_response_single:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-single'
- type: object
properties:
result:
type: object
load-balancing_longitude:
type: number
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.
addressing_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
zero-trust-gateway_api-response-single:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
dns-custom-nameservers_api-response-single:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
dns-firewall_maximum_cache_ttl:
type: number
description: Maximum DNS Cache TTL.
default: 900
example: 900
minimum: 30
maximum: 36000
teams-devices_type:
type: string
description: The type of device posture rule.
enum:
- file
- application
- tanium
- gateway
- warp
- disk_encryption
- sentinelone
- carbonblack
- firewall
- os_version
- domain_joined
- client_certificate
- unique_client_id
- kolide
- tanium_s2s
- crowdstrike_s2s
- intune
- workspace_one
- sentinelone_s2s
example: file
iam_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
bill-subs-api_subscription-v2:
type: object
properties:
app:
properties:
install_id:
$ref: '#/components/schemas/bill-subs-api_install_id'
component_values:
$ref: '#/components/schemas/bill-subs-api_component_values'
currency:
$ref: '#/components/schemas/bill-subs-api_currency'
current_period_end:
$ref: '#/components/schemas/bill-subs-api_current_period_end'
current_period_start:
$ref: '#/components/schemas/bill-subs-api_current_period_start'
frequency:
$ref: '#/components/schemas/bill-subs-api_frequency'
id:
$ref: '#/components/schemas/bill-subs-api_schemas-identifier'
price:
$ref: '#/components/schemas/bill-subs-api_price'
rate_plan:
$ref: '#/components/schemas/bill-subs-api_rate_plan'
state:
$ref: '#/components/schemas/bill-subs-api_state'
zone:
$ref: '#/components/schemas/bill-subs-api_zone'
dlp_DatasetNewVersion:
type: object
required:
- version
- max_cells
properties:
max_cells:
type: integer
format: int64
minimum: 0
secret:
type: string
format: password
version:
type: integer
format: int64
images_image_response_blob:
anyOf:
- type: string
- type: object
example:
magic_wan_update_request:
type: object
properties:
wan:
type: object
properties:
description:
type: string
physport:
$ref: '#/components/schemas/magic_port'
priority:
type: integer
static_addressing:
$ref: '#/components/schemas/magic_wan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
zero-trust-gateway_beta:
type: boolean
description: True if the category is in beta and subject to change.
example: false
turnstile_api-response-common:
type: object
required:
- success
- errors
- messages
properties:
errors:
$ref: '#/components/schemas/turnstile_messages'
messages:
$ref: '#/components/schemas/turnstile_messages'
success:
type: boolean
description: Whether the API call was successful
example: true
workers_domain_identifier:
description: Identifer of the Worker Domain.
example: dbe10b4bc17c295377eabd600e1787fd
legacy-jhs_rule:
type: object
required:
- id
- mode
- allowed_modes
- configuration
properties:
allowed_modes:
type: array
description: The available actions that a rule can apply to a matched request.
example:
- whitelist
- block
- challenge
- js_challenge
- managed_challenge
readOnly: true
items:
$ref: '#/components/schemas/legacy-jhs_schemas-mode'
configuration:
$ref: '#/components/schemas/legacy-jhs_schemas-configuration'
created_on:
type: string
format: date-time
description: The timestamp of when the rule was created.
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
id:
$ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
mode:
$ref: '#/components/schemas/legacy-jhs_schemas-mode'
modified_on:
type: string
format: date-time
description: The timestamp of when the rule was last modified.
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
notes:
$ref: '#/components/schemas/legacy-jhs_notes'
registrar-api_email:
type: string
description: The contact email address of the user.
example: user@example.com
maxLength: 90
stream_live_input_recording_allowedOrigins:
type: array
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
magic_route_add_single_request:
type: object
required:
- prefix
- nexthop
- priority
properties:
description:
$ref: '#/components/schemas/magic_description'
nexthop:
$ref: '#/components/schemas/magic_nexthop'
prefix:
$ref: '#/components/schemas/magic_prefix'
priority:
$ref: '#/components/schemas/magic_priority'
scope:
$ref: '#/components/schemas/magic_scope'
weight:
$ref: '#/components/schemas/magic_weight'
intel_schemas-ip:
properties:
belongs_to_ref:
type: object
description: Specifies a reference to the autonomous systems (AS) that the IP address belongs to.
properties:
country:
type: string
example: US
description:
type: string
example: CLOUDFLARENET
id:
example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8
type:
type: string
description: Infrastructure type of this ASN.
enum:
- hosting_provider
- isp
- organization
example: hosting_provider
value:
type: string
ip:
$ref: '#/components/schemas/intel_ip'
risk_types:
example:
- id: 131
name: Phishing
super_category_id: 21
rulesets_RulesResponse:
type: array
title: Rules
description: The list of rules in the ruleset.
items:
$ref: '#/components/schemas/rulesets_RuleResponse'
access_last_seen_identity_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/access_identity'
type: object
lists_item_redirect:
description: The definition of the redirect.
required:
- source_url
- target_url
properties:
include_subdomains:
type: boolean
default: false
preserve_path_suffix:
type: boolean
default: false
preserve_query_string:
type: boolean
default: false
source_url:
type: string
example: example.com/arch
status_code:
type: integer
enum:
- 301
- 302
- 307
- 308
default: 301
subpath_matching:
type: boolean
default: false
target_url:
type: string
example: https://archlinux.org/
iam_api-response-single-id:
allOf:
- $ref: '#/components/schemas/iam_api-response-common'
- properties:
result:
type: object
nullable: true
required:
- id
properties:
id:
$ref: '#/components/schemas/iam_common_components-schemas-identifier'
type: object
teams-devices_sentinelone_s2s_config_request:
type: object
title: SentinelOne S2S Config
required:
- api_url
- client_secret
properties:
api_url:
type: string
description: The SentinelOne S2S API URL.
example: https://example.sentinelone.net
client_secret:
type: string
description: The SentinelOne S2S client secret.
example: example client secret
zero-trust-gateway_description:
type: string
description: The description of the list.
example: The serial numbers for administrators
load-balancing_expected_body:
type: string
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
workers_compatibility_flag:
type: string
description: A flag to opt into a specific change
example: formdata_parser_supports_files
lists_list:
type: object
properties:
created_on:
$ref: '#/components/schemas/lists_created_on'
description:
$ref: '#/components/schemas/lists_description'
id:
$ref: '#/components/schemas/lists_list_id'
kind:
$ref: '#/components/schemas/lists_kind'
modified_on:
$ref: '#/components/schemas/lists_modified_on'
name:
$ref: '#/components/schemas/lists_name'
num_items:
$ref: '#/components/schemas/lists_num_items'
num_referencing_filters:
$ref: '#/components/schemas/lists_num_referencing_filters'
images_image_key_name:
type: string
description: Key name.
example: default
readOnly: true
dlp_pattern:
type: object
title: Pattern
description: A pattern that matches an entry
required:
- regex
properties:
regex:
type: string
description: The regex pattern.
example: ^4[0-9]{6,14}$
validation:
type: string
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
turnstile_modified_on:
type: string
format: date-time
description: When the widget was modified.
example: '2014-01-01T05:20:00.123123Z'
readOnly: true
addressing_schemas-can_delete:
type: boolean
description: Controls whether the membership can be deleted via the API or not.
example: true
load-balancing_description:
type: string
description: Object description.
example: Login page monitor
access_apps_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_apps'
stream_requireSignedURLs:
type: boolean
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.
default: false
example: true
workers_namespace-single-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
$ref: '#/components/schemas/workers_namespace-response'
access_everyone_rule:
type: object
title: Everyone
description: Matches everyone.
required:
- everyone
properties:
everyone:
type: object
description: An empty object which matches on all users.
example: {}
tls-certificates-and-hostnames_certificate_response_single_post:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObjectPost'
type: object
teams-devices_split_tunnel_include:
type: object
required:
- address
- description
properties:
address:
type: string
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
description:
type: string
description: A description of the split tunnel item, displayed in the client UI.
example: Include testing domains from the tunnel
maxLength: 100
host:
type: string
description: The domain name to include in the tunnel. If host is present, address must not be present.
example: '*.example.com'
workers_hostname:
type: string
description: Hostname of the Worker Domain.
example: foo.example.com
addressing_enabled:
type: boolean
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.
default: false
example: true
nullable: true
teams-devices_config_response:
oneOf:
- $ref: '#/components/schemas/teams-devices_workspace_one_config_response'
type: object
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
dns_dns_analytics_api_metrics:
type: string
description: A comma-separated list of metrics to query.
example: queryCount,uncachedCount
bill-subs-api_account_subscription_response_collection:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/bill-subs-api_subscription'
workers_usage_model:
type: string
description: Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
example: unbound
pattern: ^(bundled|unbound)$
logpush_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
teams-devices_workspace_one_input_request:
type: object
title: Workspace One S2S Input
required:
- connection_id
- compliance_status
properties:
compliance_status:
type: string
description: Compliance Status
enum:
- compliant
- noncompliant
- unknown
example: compliant
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
addressing_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
pages_projects-response:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
- properties:
result:
type: array
items:
$ref: '#/components/schemas/pages_deployments'
access_centrify:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
centrify_account:
type: string
description: Your centrify account url
example: https://abc123.my.centrify.com/
centrify_app_id:
type: string
description: Your centrify app id
example: exampleapp
type: object
title: Centrify
pages_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
load-balancing_origins:
type: array
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/load-balancing_origin'
teams-devices_id_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/teams-devices_uuid'
bill-subs-api_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
rulesets_RulesetKind:
type: string
title: Kind
description: The kind of the ruleset.
enum:
- managed
- custom
- root
- zone
example: root
security-center_dismissed:
type: boolean
example: false
intel_url_id_param:
type: object
properties:
url_id:
$ref: '#/components/schemas/intel_url_id'
access_allow_all_headers:
type: boolean
description: Allows all HTTP request headers.
example: true
addressing_ipam-delegations:
type: object
properties:
cidr:
$ref: '#/components/schemas/addressing_cidr'
created_at:
$ref: '#/components/schemas/addressing_timestamp'
delegated_account_id:
$ref: '#/components/schemas/addressing_delegated_account_identifier'
id:
$ref: '#/components/schemas/addressing_delegation_identifier'
modified_at:
$ref: '#/components/schemas/addressing_timestamp'
parent_prefix_id:
$ref: '#/components/schemas/addressing_identifier'
aaa_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_pagerduty'
workers_zone_identifier:
description: Identifier of the zone.
example: 593c9c94de529bbbfaac7c53ced0447d
access_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
dns_dns_analytics_api_result:
type: object
required:
- rows
- totals
- min
- max
- data_lag
- query
- data
properties:
data:
$ref: '#/components/schemas/dns_dns_analytics_api_data'
data_lag:
type: number
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
max:
type: object
description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object.
min:
type: object
description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object.
query:
$ref: '#/components/schemas/dns_dns_analytics_api_query'
rows:
type: number
description: Total number of rows in the result.
example: 100
minimum: 0
totals:
type: object
description: Total results for metrics across all data (object mapping metric names to values).
zero-trust-gateway_value:
type: string
description: The value of the item in a list.
example: 8GE8721REF
registrar-api_api-response-collection:
allOf:
- $ref: '#/components/schemas/registrar-api_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/registrar-api_result_info'
type: object
teams-devices_tls_config_request:
type: object
required:
- tls_sockaddr
properties:
sha256:
type: string
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
tls_sockaddr:
type: string
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
tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 50
total_count:
example: 1
total_pages:
example: 1
load-balancing_Host:
type: array
description: The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
items:
type: string
example: example.com
stream_playback_srt:
type: object
description: Details for playback from an live input using SRT.
properties:
passphrase:
$ref: '#/components/schemas/stream_playback_srt_stream_passphrase'
streamId:
$ref: '#/components/schemas/stream_playback_srt_stream_id'
url:
$ref: '#/components/schemas/stream_playback_srt_url'
zero-trust-gateway_locations:
type: object
properties:
client_default:
$ref: '#/components/schemas/zero-trust-gateway_client-default'
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
doh_subdomain:
$ref: '#/components/schemas/zero-trust-gateway_subdomain'
ecs_support:
$ref: '#/components/schemas/zero-trust-gateway_ecs-support'
id:
$ref: '#/components/schemas/zero-trust-gateway_schemas-uuid'
ip:
$ref: '#/components/schemas/zero-trust-gateway_ip'
name:
$ref: '#/components/schemas/zero-trust-gateway_schemas-name'
networks:
$ref: '#/components/schemas/zero-trust-gateway_networks'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
images_account_identifier:
type: string
description: Account identifier tag.
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
email_api-response-collection:
allOf:
- $ref: '#/components/schemas/email_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/email_result_info'
type: object
vectorize_index-delete-vectors-by-id-request:
type: object
properties:
ids:
type: array
description: A list of vector identifiers to delete from the index indicated by the path.
example:
- 5121db81354a40c6aedc3fe1ace51c59
- f90eb49c2107486abdfd78c67e853430
items:
$ref: '#/components/schemas/vectorize_identifier'
magic_wan_static_addressing:
type: object
description: (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
required:
- address
- gateway_address
properties:
address:
$ref: '#/components/schemas/magic_cidr'
gateway_address:
$ref: '#/components/schemas/magic_ip-address'
secondary_address:
$ref: '#/components/schemas/magic_cidr'
workers_consumer_name:
type: string
example: example-consumer
stream_copyAudioTrack:
type: object
required:
- label
properties:
label:
$ref: '#/components/schemas/stream_audio_label'
url:
type: string
format: uri
description: An audio track 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://www.examplestorage.com/audio_file.mp3
workers_script-settings-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
bindings:
$ref: '#/components/schemas/workers_bindings'
compatibility_date:
$ref: '#/components/schemas/workers_compatibility_date'
compatibility_flags:
$ref: '#/components/schemas/workers_compatibility_flags'
logpush:
$ref: '#/components/schemas/workers_logpush'
migrations:
oneOf:
- $ref: '#/components/schemas/workers_single_step_migrations'
- $ref: '#/components/schemas/workers_stepped_migrations'
description: Migrations to apply for Durable Objects associated with this Worker.
placement:
$ref: '#/components/schemas/workers_placement_config'
tags:
$ref: '#/components/schemas/workers_tags'
tail_consumers:
$ref: '#/components/schemas/workers_tail_consumers'
usage_model:
$ref: '#/components/schemas/workers_usage_model'
lists_num_referencing_filters:
type: number
description: The number of [filters](/operations/filters-list-filters) referencing the list.
example: 2
cloudforce-one_request-item:
type: object
title: Request Item
required:
- id
- created
- updated
- content
- priority
- request
- summary
- tlp
properties:
completed:
$ref: '#/components/schemas/cloudforce-one_time'
content:
$ref: '#/components/schemas/cloudforce-one_request-content'
created:
$ref: '#/components/schemas/cloudforce-one_time'
id:
$ref: '#/components/schemas/cloudforce-one_uuid'
message_tokens:
type: integer
description: Tokens for the request messages
example: 1
priority:
$ref: '#/components/schemas/cloudforce-one_time'
readable_id:
$ref: '#/components/schemas/cloudforce-one_request-readable-id'
request:
$ref: '#/components/schemas/cloudforce-one_request-type'
status:
$ref: '#/components/schemas/cloudforce-one_request-status'
summary:
$ref: '#/components/schemas/cloudforce-one_request-summary'
tlp:
$ref: '#/components/schemas/cloudforce-one_tlp'
tokens:
type: integer
description: Tokens for the request
example: 16
updated:
$ref: '#/components/schemas/cloudforce-one_time'
load-balancing_monitor:
allOf:
- $ref: '#/components/schemas/load-balancing_monitor-editable'
- type: object
properties:
created_on:
$ref: '#/components/schemas/load-balancing_timestamp'
id:
$ref: '#/components/schemas/load-balancing_identifier'
modified_on:
$ref: '#/components/schemas/load-balancing_timestamp'
stream_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/stream_errorReasonCode'
errorReasonText:
$ref: '#/components/schemas/stream_errorReasonText'
pctComplete:
$ref: '#/components/schemas/stream_pctComplete'
state:
$ref: '#/components/schemas/stream_media_state'
rulesets_RuleId:
type: string
title: ID
description: The unique ID of the rule.
example: 3a03d665bac047339bb530ecb439a90d
pattern: ^[0-9a-f]{32}$
digital-experience-monitoring_device_id:
type: string
description: Device-specific ID, given as UUID v4
example: cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7
rulesets_RulesetId:
type: string
title: ID
description: The unique ID of the ruleset.
example: 2f2feab2026849078ba485f918791bdc
pattern: ^[0-9a-f]{32}$
intel_name:
type: string
description: The name of the indicator feed
load-balancing_origin:
type: object
properties:
address:
$ref: '#/components/schemas/load-balancing_address'
disabled_at:
$ref: '#/components/schemas/load-balancing_disabled_at'
enabled:
$ref: '#/components/schemas/load-balancing_schemas-enabled'
header:
$ref: '#/components/schemas/load-balancing_schemas-header'
name:
$ref: '#/components/schemas/load-balancing_schemas-name'
virtual_network_id:
$ref: '#/components/schemas/load-balancing_virtual_network_id'
weight:
$ref: '#/components/schemas/load-balancing_weight'
aaa_schemas-description:
type: string
description: Optional description for the Notification policy.
example: Something describing the policy.
legacy-jhs_rule_components-schemas-identifier:
type: string
description: The unique identifier of the IP Access rule.
example: 92f17202ed8bd63d69a66b86a49a8f6b
readOnly: true
maxLength: 32
stream_clipping:
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
clippedFromVideoUID:
$ref: '#/components/schemas/stream_clipped_from_video_uid'
created:
$ref: '#/components/schemas/stream_clipping_created'
creator:
$ref: '#/components/schemas/stream_creator'
endTimeSeconds:
$ref: '#/components/schemas/stream_end_time_seconds'
maxDurationSeconds:
$ref: '#/components/schemas/stream_maxDurationSeconds'
meta:
$ref: '#/components/schemas/stream_media_metadata'
modified:
$ref: '#/components/schemas/stream_live_input_modified'
playback:
$ref: '#/components/schemas/stream_playback'
preview:
$ref: '#/components/schemas/stream_preview'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
startTimeSeconds:
$ref: '#/components/schemas/stream_start_time_seconds'
status:
$ref: '#/components/schemas/stream_media_state'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
watermark:
$ref: '#/components/schemas/stream_watermarkAtUpload'
teams-devices_device-dex-test-schemas-enabled:
type: boolean
description: Determines whether or not the test is active.
example: true
cloudforce-one_request-type:
type: string
description: Requested information from request
example: Victomology
tls-certificates-and-hostnames_components-schemas-certificateObject:
properties:
ca:
$ref: '#/components/schemas/tls-certificates-and-hostnames_ca'
certificates:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificates'
expires_on:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on'
id:
$ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
issuer:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-issuer'
name:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-name'
serial_number:
$ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number'
signature:
$ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
uploaded_on:
$ref: '#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on'
magic_replay_protection:
type: boolean
description: If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.
default: false
example: false
stream_scale:
type: number
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.
default: 0.15
example: 0.1
minimum: 0
maximum: 1
addressing_on_demand_enabled:
type: boolean
description: Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
example: true
dns_dns_analytics_api_limit:
type: integer
description: Limit number of returned metrics.
default: 100000
example: 100
vectorize_index-preset-configuration:
type: object
required:
- preset
properties:
preset:
$ref: '#/components/schemas/vectorize_index-preset'
zero-trust-gateway_dns_resolver_settings:
type: object
required:
- ip
properties:
ip:
type: string
description: IP address of upstream resolver.
example: 2001:DB8::/64
port:
type: integer
description: A port number to use for upstream resolver.
example: 5053
route_through_private_network:
type: boolean
description: Whether to connect to this resolver over a private network. Must be set when vnet_id is set.
example: true
vnet_id:
type: string
description: Optionally specify a virtual network for this resolver. Uses default virtual network id if omitted.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
magic_lan_update_request:
type: object
properties:
lan:
type: object
properties:
description:
type: string
nat:
$ref: '#/components/schemas/magic_nat'
physport:
$ref: '#/components/schemas/magic_port'
routed_subnets:
type: array
items:
$ref: '#/components/schemas/magic_routed_subnet'
static_addressing:
$ref: '#/components/schemas/magic_lan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
images_image_metadata:
type: object
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
stream_upload_length:
type: integer
description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
minimum: 0
magic-visibility_mnm_config_router_ips:
type: array
items:
$ref: '#/components/schemas/magic-visibility_mnm_config_router_ip'
load-balancing_schemas-single_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/load-balancing_pool'
stream_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/stream_messages'
messages:
$ref: '#/components/schemas/stream_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
vectorize_create-index-request:
type: object
required:
- name
- config
properties:
config:
allOf:
- $ref: '#/components/schemas/vectorize_index-configuration'
- required:
- preset
- dimensions
- metric
description:
$ref: '#/components/schemas/vectorize_index-description'
name:
$ref: '#/components/schemas/vectorize_index-name'
registrar-api_contacts:
allOf:
- $ref: '#/components/schemas/registrar-api_contact_properties'
type: object
stream_scheduledDeletion:
type: string
format: date-time
description: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
example: '2014-01-02T02:20:00Z'
addressing_on_demand_locked:
type: boolean
description: Whether advertisement status of the prefix is locked, meaning it cannot be changed.
example: false
secondary-dns_components-schemas-identifier:
example: 23ff594956f20c2a721606e94745a8aa
readOnly: true
digital-experience-monitoring_status:
type: string
description: Network status
example: connected
stream_watermark_created:
type: string
format: date-time
description: The date and a time a watermark profile was created.
example: '2014-01-02T02:20:00Z'
addressing_delegation_identifier:
type: string
description: Delegation identifier tag.
example: d933b1530bc56c9953cf8ce166da8004
readOnly: true
maxLength: 32
images_images_stats_count:
type: object
properties:
allowed:
$ref: '#/components/schemas/images_images_stats_allowed'
current:
$ref: '#/components/schemas/images_images_stats_current'
zero-trust-gateway_enabled_upload_phase:
type: boolean
description: Enable anti-virus scanning on uploads.
example: false
magic_interface_address:
type: string
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
access_max_age:
type: number
description: The maximum number of seconds the results of a preflight request can be cached.
example: -1
minimum: -1
maximum: 86400
access_enable_binding_cookie:
type: boolean
description: Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
default: false
addressing_memberships:
type: array
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/addressing_address-maps-membership'
tls-certificates-and-hostnames_signature:
type: string
description: The type of hash used for the certificate.
example: SHA256WithRSA
readOnly: true
digital-experience-monitoring_version:
type: string
description: WARP client version
example: 1.0.0
addressing_bgp_signaling_modified_at:
type: string
format: date-time
description: Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.
example: '2014-01-01T05:20:00.12345Z'
nullable: true
aaa_sent:
type: string
format: date-time
description: Timestamp of when the notification was dispatched in ISO 8601 format.
example: '2021-10-08T17:52:17.571336Z'
workers_deployments-single-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
id:
type: string
example: 18f97339-c287-4872-9bdd-e2135c07ec12
metadata:
type: object
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
number:
type: number
example: 1
resources:
type: object
example:
bindings:
- json: example_binding
name: JSON_VAR
type: json
script:
etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
handlers:
- fetch
last_deployed_from: api
script_runtime:
usage_model: bundled
tunnel_schemas-comment:
type: string
description: Optional remark describing the virtual network.
example: Staging VPC for data science
load-balancing_health_details:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
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
lists_item:
oneOf:
- $ref: '#/components/schemas/lists_item_ip'
- $ref: '#/components/schemas/lists_item_redirect'
- $ref: '#/components/schemas/lists_item_hostname'
- $ref: '#/components/schemas/lists_item_asn'
type: object
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'
properties:
asn:
$ref: '#/components/schemas/lists_item_asn'
comment:
$ref: '#/components/schemas/lists_item_comment'
created_on:
type: string
description: The RFC 3339 timestamp of when the item was created.
example: '2020-01-01T08:00:00Z'
readOnly: true
hostname:
$ref: '#/components/schemas/lists_item_hostname'
id:
$ref: '#/components/schemas/lists_list_id'
ip:
$ref: '#/components/schemas/lists_item_ip'
modified_on:
type: string
description: The RFC 3339 timestamp of when the item was last modified.
example: '2020-01-10T14:00:00Z'
readOnly: true
redirect:
$ref: '#/components/schemas/lists_item_redirect'
addressing_response_collection_bgp:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
magic-transit_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
access_onetimepin:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- properties:
config:
type: object
type:
enum:
- onetimepin
type: object
title: One Time Pin
stream_input_srt:
type: object
description: Details for streaming to a live input using SRT.
properties:
passphrase:
$ref: '#/components/schemas/stream_input_srt_stream_passphrase'
streamId:
$ref: '#/components/schemas/stream_input_srt_stream_id'
url:
$ref: '#/components/schemas/stream_input_srt_url'
intel_inherited_risk_types:
$ref: '#/components/schemas/intel_categories_with_super_category_ids_example_empty'
access_tags_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/access_tag'
pages_domains-post:
example:
name: example.com
workers-kv_api-response-collection:
allOf:
- $ref: '#/components/schemas/workers-kv_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/workers-kv_result_info'
type: object
stream_videos:
type: object
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
created:
$ref: '#/components/schemas/stream_created'
creator:
$ref: '#/components/schemas/stream_creator'
duration:
$ref: '#/components/schemas/stream_duration'
input:
$ref: '#/components/schemas/stream_input'
liveInput:
$ref: '#/components/schemas/stream_liveInput'
maxDurationSeconds:
$ref: '#/components/schemas/stream_maxDurationSeconds'
meta:
$ref: '#/components/schemas/stream_media_metadata'
modified:
$ref: '#/components/schemas/stream_modified'
playback:
$ref: '#/components/schemas/stream_playback'
preview:
$ref: '#/components/schemas/stream_preview'
readyToStream:
$ref: '#/components/schemas/stream_readyToStream'
readyToStreamAt:
$ref: '#/components/schemas/stream_readyToStreamAt'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
size:
$ref: '#/components/schemas/stream_size'
status:
$ref: '#/components/schemas/stream_media_status'
thumbnail:
$ref: '#/components/schemas/stream_thumbnail_url'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
uid:
$ref: '#/components/schemas/stream_identifier'
uploadExpiry:
$ref: '#/components/schemas/stream_oneTimeUploadExpiry'
uploaded:
$ref: '#/components/schemas/stream_uploaded'
watermark:
$ref: '#/components/schemas/stream_watermarks'
images_image_response_single:
allOf:
- $ref: '#/components/schemas/images_api-response-single'
- properties:
result:
$ref: '#/components/schemas/images_image'
access_app_id:
oneOf:
- $ref: '#/components/schemas/access_identifier'
- $ref: '#/components/schemas/access_uuid'
access_schemas-email:
type: string
format: email
description: The email of the user.
example: jdoe@example.com
iam_email:
type: string
description: The contact email address of the user.
example: user@example.com
maxLength: 90
magic_ip-address:
type: string
description: A valid IPv4 address.
example: 192.0.2.1
custom-pages_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
access_users_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 100
total_count:
example: 1
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_users'
cloudforce-one_request-readable-id:
type: string
title: Request Readable ID
description: Readable Request ID
example: RFI-2022-000001
workers_binding:
oneOf:
- $ref: '#/components/schemas/workers_kv_namespace_binding'
- $ref: '#/components/schemas/workers_service_binding'
- $ref: '#/components/schemas/workers_do_binding'
- $ref: '#/components/schemas/workers_r2_binding'
- $ref: '#/components/schemas/workers_queue_binding'
- $ref: '#/components/schemas/workers_d1_binding'
- $ref: '#/components/schemas/workers_dispatch_namespace_binding'
- $ref: '#/components/schemas/workers_mtls_cert_binding'
type: object
description: A binding to allow the Worker to communicate with resources
addressing_id_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/addressing_delegation_identifier'
r2_account_identifier:
type: string
description: Account ID
example: 023e105f4ecef8ad9ca31a8372d0c353
maxLength: 32
magic-transit_traceroute_time_ms:
type: integer
description: Total time of traceroute in ms.
intel_asn_components-schemas-response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_asn'
intel_schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_whois'
turnstile_sitekey:
type: string
description: Widget item identifier tag.
example: 0x4AAF00AAAABn0R22HWm-YUc
maxLength: 32
cloudforce-one_labels:
type: array
title: Labels
description: List of labels
example:
- DoS
- CVE
items:
type: string
magic_sites_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
sites:
type: array
items:
$ref: '#/components/schemas/magic_site'
legacy-jhs_account_identifier: {}
vectorize_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
tls-certificates-and-hostnames_components-schemas-private_key:
type: string
description: The private key for the certificate
example: '--BEGIN PRIVATE KEY--
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/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=
--END PRIVATE KEY--'
zero-trust-gateway_anti-virus-settings:
type: object
description: Anti-virus settings.
properties:
enabled_download_phase:
$ref: '#/components/schemas/zero-trust-gateway_enabled_download_phase'
enabled_upload_phase:
$ref: '#/components/schemas/zero-trust-gateway_enabled_upload_phase'
fail_closed:
$ref: '#/components/schemas/zero-trust-gateway_fail_closed'
notification_settings:
$ref: '#/components/schemas/zero-trust-gateway_notification_settings'
teams-devices_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-managed-networks'
r2_bucket:
type: object
description: A single R2 bucket
properties:
creation_date:
type: string
description: Creation timestamp
location:
$ref: '#/components/schemas/r2_bucket_location'
name:
$ref: '#/components/schemas/r2_bucket_name'
rum_api-response-common:
type: object
required:
- success
- errors
- messages
properties:
errors:
$ref: '#/components/schemas/rum_messages'
messages:
$ref: '#/components/schemas/rum_messages'
success:
type: boolean
description: Whether the API call was successful.
example: true
registrar-api_organization:
type: string
description: Name of organization.
example: Cloudflare, Inc.
load-balancing_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/load-balancing_messages'
messages:
$ref: '#/components/schemas/load-balancing_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
secondary-dns_schemas-single_response:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-single'
- properties:
result:
$ref: '#/components/schemas/secondary-dns_peer'
workers-kv_components-schemas-result:
allOf:
- $ref: '#/components/schemas/workers-kv_result'
- properties:
data:
example:
- metrics:
- - 2
- 4
- - 16
- 32
max:
example:
storedBytes: 32
storedKeys: 4
min:
example:
storedBytes: 16
storedKeys: 2
query:
$ref: '#/components/schemas/workers-kv_query'
totals:
example:
storedBytes: 48
storedKeys: 6
dns-custom-nameservers_api-response-collection:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/dns-custom-nameservers_result_info'
type: object
load-balancing_origin_steering:
type: object
description: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
properties:
policy:
type: string
description: 'The type of origin steering policy to use.
- `"random"`: Select an origin randomly.
- `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
- `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin''s number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
- `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin''s number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.'
enum:
- random
- hash
- least_outstanding_requests
- least_connections
default: random
load-balancing_region_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
workers-kv_query:
type: object
description: For specifying result metrics.
properties:
dimensions:
type: array
description: Can be used to break down the data by given attributes.
default: '[]'
items:
type: string
description: For drilling down on metrics.
filters:
type: string
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:
Operator | Name | URL Encoded
--||--
== | Equals | %3D%3D
!= | Does not equals | !%3D
> | Greater Than | %3E
< | Less Than | %3C
>= | Greater than or equal to | %3E%3D
<= | Less than or equal to | %3C%3D .'
default: '""'
limit:
type: integer
description: Limit number of returned metrics.
default: 10000
metrics:
type: array
description: One or more metrics to compute.
items:
type: string
description: A quantitative measurement of KV usage.
since:
type: string
format: date-time
description: Start of time interval to query, defaults to 6 hours before request received.
default: <6 hours ago>
example: '2019-01-02T02:20:00Z'
sort:
type: array
description: Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).
default: '[]'
items: {}
until:
type: string
format: date-time
description: End of time interval to query, defaults to current time.
default:
example: '2019-01-02T03:20:00Z'
zero-trust-gateway_cf_account_id:
type: string
description: Cloudflare account ID.
example: 699d98642c564d2e855e9661899b7252
maxLength: 32
zero-trust-gateway_block-page-settings:
type: object
description: Block page layout settings.
properties:
background_color:
type: string
description: 'Block page background color in #rrggbb format.'
enabled:
type: boolean
description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
example: true
footer_text:
type: string
description: Block page footer text.
example: --footer--
header_text:
type: string
description: Block page header text.
example: --header--
logo_path:
type: string
description: Full URL to the logo file.
example: https://logos.com/a.png
mailto_address:
type: string
description: Admin email for users to contact.
example: admin@example.com
mailto_subject:
type: string
description: Subject line for emails created from block page.
example: Blocked User Inquiry
name:
type: string
description: Block page title.
example: Cloudflare
suppress_footer:
type: boolean
description: Suppress detailed info at the bottom of the block page.
example: false
teams-devices_api-response-collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/teams-devices_result_info'
type: object
zero-trust-gateway_schemas-description:
type: string
description: The description of the rule.
example: Block bad websites based on their host name.
load-balancing_components-schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
tunnel_run_at:
type: string
format: date-time
description: Timestamp of when the tunnel connection was started.
example: '2009-11-10T23:00:00Z'
load-balancing_probe_zone:
type: string
description: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
example: example.com
zero-trust-gateway_gateway-account-logging-settings:
type: object
properties:
redact_pii:
type: boolean
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
settings_by_rule_type:
type: object
description: Logging settings by rule type.
properties:
dns:
type: object
description: Logging settings for DNS firewall.
http:
type: object
description: Logging settings for HTTP/HTTPS firewall.
l4:
type: object
description: Logging settings for Network firewall.
iam_permissions:
type: object
example:
analytics:
read: true
write: false
zones:
read: true
write: true
properties:
analytics:
$ref: '#/components/schemas/iam_grants'
billing:
$ref: '#/components/schemas/iam_grants'
cache_purge:
$ref: '#/components/schemas/iam_grants'
dns:
$ref: '#/components/schemas/iam_grants'
dns_records:
$ref: '#/components/schemas/iam_grants'
lb:
$ref: '#/components/schemas/iam_grants'
logs:
$ref: '#/components/schemas/iam_grants'
organization:
$ref: '#/components/schemas/iam_grants'
ssl:
$ref: '#/components/schemas/iam_grants'
waf:
$ref: '#/components/schemas/iam_grants'
zone_settings:
$ref: '#/components/schemas/iam_grants'
zones:
$ref: '#/components/schemas/iam_grants'
email_destination_address_properties:
type: object
properties:
created:
$ref: '#/components/schemas/email_created'
email:
$ref: '#/components/schemas/email_email'
id:
$ref: '#/components/schemas/email_destination_address_identifier'
modified:
$ref: '#/components/schemas/email_modified'
tag:
$ref: '#/components/schemas/email_destination_address_tag'
verified:
$ref: '#/components/schemas/email_verified'
images_images_stats_allowed:
type: number
description: Cloudflare Images allowed usage.
example: 100000
readOnly: true
rum_site:
type: object
properties:
auto_install:
$ref: '#/components/schemas/rum_auto_install'
created:
$ref: '#/components/schemas/rum_timestamp'
rules:
$ref: '#/components/schemas/rum_rules'
ruleset:
$ref: '#/components/schemas/rum_ruleset'
site_tag:
$ref: '#/components/schemas/rum_site_tag'
site_token:
$ref: '#/components/schemas/rum_site_token'
snippet:
$ref: '#/components/schemas/rum_snippet'
tunnel_deleted_at:
type: string
format: date-time
description: Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been deleted.
example: '2009-11-10T23:00:00Z'
nullable: true
access_allow_authenticate_via_warp:
type: boolean
description: When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.
example: 'false'
access_auto_redirect_to_identity:
type: boolean
description: When set to `true`, users skip the identity provider selection step during login.
default: false
tunnel_route_id:
type: string
description: UUID of the route.
example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
load-balancing_search_result:
type: object
properties:
result:
$ref: '#/components/schemas/load-balancing_search'
access_okta_group_rule:
type: object
title: Okta group
description: 'Matches an Okta group.
Requires an Okta identity provider.'
required:
- okta
properties:
okta:
type: object
required:
- email
- connection_id
properties:
connection_id:
type: string
description: The ID of your Okta identity provider.
example: ea85612a-29c8-46c2-bacb-669d65136971
email:
type: string
description: The email of the Okta group.
example: devs@cloudflare.com
teams-devices_exclude:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel'
magic_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
secondary-dns_schemas-identifier:
example: 69cd1e104af3e6ed3cb344f263fd0d5a
readOnly: true
magic_lan_static_addressing:
type: object
description: If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.
required:
- address
properties:
address:
$ref: '#/components/schemas/magic_cidr'
dhcp_relay:
$ref: '#/components/schemas/magic_lan_dhcp_relay'
dhcp_server:
$ref: '#/components/schemas/magic_lan_dhcp_server'
secondary_address:
$ref: '#/components/schemas/magic_cidr'
virtual_address:
$ref: '#/components/schemas/magic_cidr'
secondary-dns_acl:
type: object
required:
- id
- name
- ip_range
properties:
id:
$ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
ip_range:
$ref: '#/components/schemas/secondary-dns_ip_range'
name:
$ref: '#/components/schemas/secondary-dns_acl_components-schemas-name'
zero-trust-gateway_identifier:
example: 699d98642c564d2e855e9661899b7252
rum_rules-response-collection:
allOf:
- $ref: '#/components/schemas/rum_api-response-collection'
- properties:
result:
type: object
properties:
rules:
$ref: '#/components/schemas/rum_rules'
ruleset:
$ref: '#/components/schemas/rum_ruleset'
iam_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/iam_messages'
messages:
$ref: '#/components/schemas/iam_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
access_custom_page:
type: object
required:
- name
- custom_html
- type
properties:
app_count:
$ref: '#/components/schemas/access_app_count'
created_at:
$ref: '#/components/schemas/access_timestamp'
custom_html:
type: string
description: Custom page HTML.
example: Access Denied
name:
$ref: '#/components/schemas/access_custom-pages_components-schemas-name'
type:
$ref: '#/components/schemas/access_schemas-type'
uid:
$ref: '#/components/schemas/access_uuid'
updated_at:
$ref: '#/components/schemas/access_timestamp'
images_image_variant_response:
type: object
properties:
variant:
$ref: '#/components/schemas/images_image_variant_definition'
intel-sinkholes_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
access_name_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- type: object
properties:
result:
type: object
properties:
name:
$ref: '#/components/schemas/access_tags_components-schemas-name'
stream_size:
type: number
description: The size of the media item in bytes.
example: 4190963
cloudforce-one_request-edit:
type: object
title: Request Editable Parameters
properties:
content:
$ref: '#/components/schemas/cloudforce-one_request-content'
priority:
type: string
description: Priority for analyzing the request
example: routine
request_type:
$ref: '#/components/schemas/cloudforce-one_request-type'
summary:
$ref: '#/components/schemas/cloudforce-one_request-summary'
tlp:
$ref: '#/components/schemas/cloudforce-one_tlp'
teams-devices_dex-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
rulesets_ExecuteRule:
allOf:
- $ref: '#/components/schemas/rulesets_Rule'
- title: Execute rule
properties:
action:
enum:
- execute
action_parameters:
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/rulesets_RulesetId'
- description: The ID of the ruleset to execute.
example: 4814384a9e5d4991b9815dcfc25d2f1f
matched_data:
type: object
title: Matched data
description: The configuration to use for matched data logging.
required:
- public_key
properties:
public_key:
type: string
title: Public key
description: The public key to encrypt matched data logs with.
example: iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0=
minLength: 1
overrides:
type: object
title: Overrides
description: A set of overrides to apply to the target ruleset.
properties:
action:
allOf:
- $ref: '#/components/schemas/rulesets_RuleAction'
- description: An action to override all rules with. This option has lower precedence than rule and category overrides.
categories:
type: array
title: Category overrides
description: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
uniqueItems: true
minItems: 1
items:
type: object
title: Category override
description: A category-level override
required:
- category
properties:
action:
allOf:
- $ref: '#/components/schemas/rulesets_RuleAction'
- description: The action to override rules in the category with.
category:
allOf:
- $ref: '#/components/schemas/rulesets_RuleCategory'
- description: The name of the category to override.
enabled:
allOf:
- $ref: '#/components/schemas/rulesets_RuleEnabled'
- description: Whether to enable execution of rules in the category.
sensitivity_level:
allOf:
- $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
- description: The sensitivity level to use for rules in the category.
minProperties: 2
enabled:
allOf:
- $ref: '#/components/schemas/rulesets_RuleEnabled'
- description: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
rules:
type: array
title: Rule overrides
description: A list of rule-level overrides. This option has the highest precedence.
uniqueItems: true
minItems: 1
items:
type: object
title: Rule override
description: A rule-level override
required:
- id
properties:
action:
allOf:
- $ref: '#/components/schemas/rulesets_RuleAction'
- description: The action to override the rule with.
enabled:
allOf:
- $ref: '#/components/schemas/rulesets_RuleEnabled'
- description: Whether to enable execution of the rule.
id:
allOf:
- $ref: '#/components/schemas/rulesets_RuleId'
- description: The ID of the rule to override.
example: 8ac8bc2a661e475d940980f9317f28e1
score_threshold:
type: integer
title: Score threshold
description: The score threshold to use for the rule.
sensitivity_level:
allOf:
- $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
- description: The sensitivity level to use for the rule.
minProperties: 2
sensitivity_level:
allOf:
- $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
- description: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.
minProperties: 1
description:
example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
intel_domain_name:
type: string
example: cloudflare.com
stream_type:
type: string
description: Specifies whether the video is `vod` or `live`.
example: live
dns-custom-nameservers_acns_response_collection:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
custom-pages_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
turnstile_secret:
type: string
description: Secret key for this widget.
example: 0x4AAF00AAAABn0R22HWm098HVBjhdsYUc
access_gateway_seat:
type: boolean
description: True if the seat is part of Gateway.
example: false
rulesets_RulesetVersion:
type: string
title: Version
description: The version of the ruleset.
example: '1'
readOnly: true
pattern: ^[0-9]+$
intel_ipv6:
type: string
format: ipv6
example: '2001:0DB8::'
magic-visibility_pcaps_system:
type: string
description: The system used to collect packet captures.
enum:
- magic-transit
example: magic-transit
stream_pem:
type: string
description: The signing key in PEM format.
example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
zero-trust-gateway_schemas-subdomain:
type: string
description: The subdomain to be used as the destination in the proxy client.
example: oli3n9zkz5.proxy.cloudflare-gateway.com
cloudforce-one_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
teams-devices_carbonblack_input_request:
type: object
title: Carbonblack
required:
- path
- operating_system
properties:
operating_system:
type: string
description: Operating system
enum:
- windows
- linux
- mac
example: mac
path:
type: string
description: File path.
example: /bin/cat
sha256:
type: string
description: SHA-256.
example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
thumbprint:
type: string
description: Signing certificate thumbprint.
example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
access_schemas-type:
type: string
description: Custom page type.
enum:
- identity_denied
- forbidden
pages_api-response-single:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
type: object
nullable: true
type: object
access_active_sessions_response:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
type: object
properties:
expiration:
type: integer
example: 1694813506
metadata:
type: object
properties:
apps:
type: object
expires:
type: integer
example: 1694813506
iat:
type: integer
example: 1694791905
nonce:
type: string
example: X1aXj1lFVcqqyoXF
ttl:
type: integer
example: 21600
name:
type: string
stream_input_webrtc_url:
type: string
description: The WebRTC URL you provide to the broadcaster, which they stream live video to.
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish
lists_operation:
type: object
required:
- id
- status
properties:
completed:
type: string
description: The RFC 3339 timestamp of when the operation was completed.
example: '2020-01-01T08:00:00Z'
readOnly: true
error:
type: string
description: A message describing the error when the status is `failed`.
example: This list is at the maximum number of items
readOnly: true
id:
$ref: '#/components/schemas/lists_operation_id'
status:
type: string
description: The current status of the asynchronous operation.
enum:
- pending
- running
- completed
- failed
example: failed
readOnly: true
stream_watermark_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
workers_compatibility_date:
type: string
description: Opt your Worker into changes after this date
example: '2022-04-05'
teams-devices_os_version_extra:
type: string
description: The operating system version extra parameter.
example: (a)
stream_video_copy_request:
required:
- url
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
creator:
$ref: '#/components/schemas/stream_creator'
meta:
$ref: '#/components/schemas/stream_media_metadata'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
url:
type: string
format: uri
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
watermark:
$ref: '#/components/schemas/stream_watermark_at_upload'
access_saas_props:
type: object
title: SaaS Application
properties:
allowed_idps:
$ref: '#/components/schemas/access_allowed_idps'
app_launcher_visible:
$ref: '#/components/schemas/access_app_launcher_visible'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
custom_pages:
$ref: '#/components/schemas/access_schemas-custom_pages'
logo_url:
$ref: '#/components/schemas/access_logo_url'
name:
$ref: '#/components/schemas/access_apps_components-schemas-name'
saas_app:
oneOf:
- $ref: '#/components/schemas/access_saml_saas_app'
- $ref: '#/components/schemas/access_oidc_saas_app'
type: object
tags:
$ref: '#/components/schemas/access_tags'
type:
type: string
description: The application type.
example: saas
aaa_filters:
type: object
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.
example:
slo:
- '99.9'
properties:
actions:
type: array
description: Usage depends on specific alert type
items:
type: string
affected_asns:
type: array
description: Used for configuring radar_notification
items:
type: string
affected_components:
type: array
description: Used for configuring incident_alert. A list of identifiers for each component to monitor.
example: 4c231tkdlpcl
items:
type: string
affected_locations:
type: array
description: Used for configuring radar_notification
items:
type: string
airport_code:
type: array
description: Used for configuring maintenance_event_notification
items:
type: string
alert_trigger_preferences:
type: array
description: Usage depends on specific alert type
items:
type: string
alert_trigger_preferences_value:
type: array
description: Used for configuring magic_tunnel_health_check_event
items:
type: string
enum:
- '99.0'
- '98.0'
- '97.0'
minItems: 1
maxItems: 1
enabled:
type: array
description: Used for configuring load_balancing_pool_enablement_alert
items:
type: string
minItems: 1
environment:
type: array
description: Used for configuring pages_event_alert
items:
type: string
minItems: 1
event:
type: array
description: Used for configuring pages_event_alert
items:
type: string
minItems: 1
event_source:
type: array
description: Used for configuring load_balancing_health_alert
items:
type: string
event_type:
type: array
description: Usage depends on specific alert type
items:
type: string
group_by:
type: array
description: Usage depends on specific alert type
items:
type: string
health_check_id:
type: array
description: Used for configuring health_check_status_notification
items:
type: string
incident_impact:
type: array
description: Used for configuring incident_alert
items:
type: string
enum:
- INCIDENT_IMPACT_NONE
- INCIDENT_IMPACT_MINOR
- INCIDENT_IMPACT_MAJOR
- INCIDENT_IMPACT_CRITICAL
input_id:
type: array
description: Used for configuring stream_live_notifications
items:
type: string
limit:
type: array
description: Used for configuring billing_usage_alert
items:
type: string
minItems: 1
logo_tag:
type: array
description: Used for configuring logo_match_alert
items:
type: string
megabits_per_second:
type: array
description: Used for configuring advanced_ddos_attack_l4_alert
items:
type: string
new_health:
type: array
description: Used for configuring load_balancing_health_alert
items:
type: string
new_status:
type: array
description: Used for configuring tunnel_health_event
items:
type: string
packets_per_second:
type: array
description: Used for configuring advanced_ddos_attack_l4_alert
items:
type: string
pool_id:
type: array
description: Usage depends on specific alert type
items:
type: string
product:
type: array
description: Used for configuring billing_usage_alert
items:
type: string
minItems: 1
project_id:
type: array
description: Used for configuring pages_event_alert
items:
type: string
minItems: 1
protocol:
type: array
description: Used for configuring advanced_ddos_attack_l4_alert
items:
type: string
query_tag:
type: array
description: Usage depends on specific alert type
items:
type: string
requests_per_second:
type: array
description: Used for configuring advanced_ddos_attack_l7_alert
items:
type: string
selectors:
type: array
description: Usage depends on specific alert type
items:
type: string
services:
type: array
description: Used for configuring clickhouse_alert_fw_ent_anomaly
items:
type: string
minItems: 1
slo:
type: array
description: Usage depends on specific alert type
items:
type: string
status:
type: array
description: Used for configuring health_check_status_notification
items:
type: string
minItems: 1
target_hostname:
type: array
description: Used for configuring advanced_ddos_attack_l7_alert
items:
type: string
target_ip:
type: array
description: Used for configuring advanced_ddos_attack_l4_alert
items:
type: string
target_zone_name:
type: array
description: Used for configuring advanced_ddos_attack_l7_alert
items:
type: string
traffic_exclusions:
type: array
description: Used for configuring traffic_anomalies_alert
items:
type: string
enum:
- security_events
maxItems: 1
tunnel_id:
type: array
description: Used for configuring tunnel_health_event
items:
type: string
tunnel_name:
type: array
description: Used for configuring magic_tunnel_health_check_event
items:
type: string
minItems: 1
where:
type: array
description: Usage depends on specific alert type
items:
type: string
zones:
type: array
description: Usage depends on specific alert type
items:
type: string
dlp_custom_profile:
type: object
title: Custom profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
created_at:
$ref: '#/components/schemas/dlp_timestamp'
description:
type: string
description: The description of the profile.
example: A standard CVV card number
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_custom_entry'
id:
$ref: '#/components/schemas/dlp_profile_id'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
type:
type: string
description: The type of the profile.
enum:
- custom
example: custom
updated_at:
$ref: '#/components/schemas/dlp_timestamp'
magic-visibility_mnm_rule_ip_prefixes:
type: array
items:
$ref: '#/components/schemas/magic-visibility_mnm_rule_ip_prefix'
dlp_profiles:
anyOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
- $ref: '#/components/schemas/dlp_custom_profile'
- $ref: '#/components/schemas/dlp_integration_profile'
registrar-api_supported_tld:
type: boolean
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
stream_storage_use_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
properties:
creator:
$ref: '#/components/schemas/stream_creator'
totalStorageMinutes:
type: integer
description: The total minutes of video content stored in the account.
totalStorageMinutesLimit:
type: integer
description: The storage capacity alloted for the account.
videoCount:
type: integer
description: The total count of videos associated with the account.
access_service-tokens_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_service-tokens'
tls-certificates-and-hostnames_api-response-collection:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/tls-certificates-and-hostnames_result_info'
type: object
dlp_new_custom_profile:
type: object
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
description:
type: string
description: The description of the profile.
example: A standard CVV card number
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_new_custom_entry'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
pages_deployment-response-details:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
$ref: '#/components/schemas/pages_deployments'
tls-certificates-and-hostnames_service:
type: string
description: The service using the certificate.
example: gateway
images_image_variant_definition:
type: object
required:
- id
- options
properties:
id:
$ref: '#/components/schemas/images_image_variant_identifier'
neverRequireSignedURLs:
$ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
options:
$ref: '#/components/schemas/images_image_variant_options'
load-balancing_virtual_network_id:
type: string
description: The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
example: a5624d4e-044a-4ff0-b3e1-e2465353d4b4
load-balancing_timeout:
type: integer
description: The timeout (in seconds) before marking the health check as failed.
default: 5
magic_wans_add_single_request:
type: object
properties:
wan:
type: object
required:
- physport
- vlan_tag
properties:
description:
type: string
physport:
$ref: '#/components/schemas/magic_port'
priority:
type: integer
static_addressing:
$ref: '#/components/schemas/magic_wan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
load-balancing_monitor_id:
description: The ID of the Monitor to use for checking the health of origins within this pool.
zero-trust-gateway_schedule:
type: object
description: The schedule for activating DNS policies. This does not apply to HTTP or network policies.
properties:
fri:
type: string
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
mon:
type: string
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
sat:
type: string
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
sun:
type: string
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
thu:
type: string
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
time_zone:
type: string
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 Gateway will use the time zone inferred from the user's source IP 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
tue:
type: string
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
wed:
type: string
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
teams-devices_fallback_domains:
type: array
items:
$ref: '#/components/schemas/teams-devices_fallback_domain'
dlp_V4ResponseMessage:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
minimum: 1000
message:
type: string
dlp_Dataset:
type: object
required:
- name
- id
- status
- num_cells
- created_at
- updated_at
- uploads
- secret
properties:
created_at:
type: string
format: date-time
description:
type: string
nullable: true
id:
type: string
format: uuid
name:
type: string
num_cells:
type: integer
format: int64
secret:
type: boolean
status:
$ref: '#/components/schemas/dlp_DatasetUploadStatus'
updated_at:
type: string
format: date-time
uploads:
type: array
items:
$ref: '#/components/schemas/dlp_DatasetUpload'
stream_input_srt_url:
type: string
description: The SRT URL you provide to the broadcaster, which they stream live video to.
example: srt://live.cloudflare.com:778
r2_v4_response_failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/r2_errors'
messages:
$ref: '#/components/schemas/r2_messages'
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic_site-name:
type: string
description: The name of the site.
example: site_1
workers_consumer:
type: object
properties:
created_on:
readOnly: true
environment:
readOnly: true
queue_name:
readOnly: true
service:
readOnly: true
settings:
type: object
properties:
batch_size:
$ref: '#/components/schemas/workers_batch_size'
max_retries:
$ref: '#/components/schemas/workers_max_retries'
max_wait_time_ms:
$ref: '#/components/schemas/workers_max_wait_time_ms'
registrar-api_first_name:
type: string
description: User's first name
example: John
nullable: true
maxLength: 60
teams-devices_serial_number:
type: string
description: The device serial number.
example: EXAMPLEHMD6R
stream_modified:
type: string
format: date-time
description: The date and time the media item was last modified.
example: '2014-01-02T02:20:00Z'
tunnel_cfd_tunnel:
type: object
description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
properties:
account_tag:
$ref: '#/components/schemas/tunnel_cf_account_id'
connections:
$ref: '#/components/schemas/tunnel_connections'
conns_active_at:
$ref: '#/components/schemas/tunnel_conns_active_at'
conns_inactive_at:
$ref: '#/components/schemas/tunnel_conns_inactive_at'
created_at:
$ref: '#/components/schemas/tunnel_created_at'
deleted_at:
$ref: '#/components/schemas/tunnel_deleted_at'
id:
$ref: '#/components/schemas/tunnel_tunnel_id'
metadata:
$ref: '#/components/schemas/tunnel_metadata'
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
remote_config:
$ref: '#/components/schemas/tunnel_remote_config'
status:
$ref: '#/components/schemas/tunnel_status'
tun_type:
$ref: '#/components/schemas/tunnel_tunnel_type'
rum_rule-id-response-single:
allOf:
- $ref: '#/components/schemas/rum_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/rum_rule_identifier'
dlp_validate_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
properties:
valid:
type: boolean
example: true
access_country_rule:
type: object
title: Country
description: Matches a specific country
required:
- geo
properties:
geo:
type: object
required:
- country_code
properties:
country_code:
type: string
description: The country code that should be matched.
example: US
access_bookmarks_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_bookmarks'
magic_route_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
route:
type: object
access_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
intel_stix_identifier:
type: string
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
tunnel_tunnel_connections_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/tunnel_tunnel_client'
email_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
teams-devices_expiration:
type: string
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
tunnel_argo-tunnel:
type: object
required:
- id
- name
- created_at
- connections
properties:
connections:
type: array
description: The tunnel connections between your origin and Cloudflare's edge.
items:
$ref: '#/components/schemas/tunnel_connection'
created_at:
$ref: '#/components/schemas/tunnel_created_at'
deleted_at:
$ref: '#/components/schemas/tunnel_deleted_at'
id:
$ref: '#/components/schemas/tunnel_tunnel_id'
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
bill-subs-api_rate_plan:
type: object
description: The rate plan applied to the subscription.
properties:
currency:
type: string
description: The currency applied to the rate plan subscription.
example: USD
externally_managed:
type: boolean
description: Whether this rate plan is managed externally from Cloudflare.
example: false
id:
description: The ID of the rate plan.
example: free
is_contract:
type: boolean
description: Whether a rate plan is enterprise-based (or newly adopted term contract).
example: false
public_name:
type: string
description: The full name of the rate plan.
example: Business Plan
scope:
type: string
description: The scope that this rate plan applies to.
example: zone
sets:
type: array
description: The list of sets this rate plan applies to.
items:
type: string
secondary-dns_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-single'
- properties:
result:
$ref: '#/components/schemas/secondary-dns_acl'
dlp_update_settings_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
required:
- public_key
properties:
public_key:
type: string
example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=
nullable: true
images_image_keys:
type: object
properties:
name:
$ref: '#/components/schemas/images_image_key_name'
value:
$ref: '#/components/schemas/images_image_key_value'
zero-trust-gateway_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
teams-devices_disable_auto_fallback:
type: boolean
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 to `true`.
example: true
zero-trust-gateway_gateway_account_config:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
- properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
type: object
type: object
iam_response_collection:
allOf:
- $ref: '#/components/schemas/iam_api-response-collection'
- type: object
properties:
result:
type: array
items:
type: object
stream_output_enabled:
type: boolean
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.
default: true
example: true
logpush_validate_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
message:
type: string
example: ''
valid:
type: boolean
example: true
legacy-jhs_api-response-collection:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/legacy-jhs_result_info'
type: object
magic-visibility_mnm_rule_ip_prefix:
type: string
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
magic_multiple_route_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_routes:
type: array
items:
$ref: '#/components/schemas/magic_route'
email_destination_address_tag:
type: string
description: Destination address tag. (Deprecated, replaced by destination address identifier)
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
deprecated: true
maxLength: 32
access_schemas-custom_pages:
type: array
description: The custom pages that will be displayed when applicable for this application
items:
type: string
description: The custom pages selected for application.
example: 699d98642c564d2e855e9661899b7252
teams-devices_mac_address:
type: string
description: The device mac address.
example: 00-00-5E-00-53-00
registrar-api_domain_name:
type: string
description: Domain name.
example: cloudflare.com
secondary-dns_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/secondary-dns_peer'
dns-firewall_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
magic-transit_wait_time:
type: integer
description: Set the time (in seconds) to wait for a response to a probe.
default: 1
minimum: 1
maximum: 5
images_image_identifier:
type: string
description: Image unique identifier.
example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900
readOnly: true
maxLength: 32
cloudforce-one_tlp:
type: string
title: TLP
description: The CISA defined Traffic Light Protocol (TLP)
enum:
- clear
- amber
- amber-strict
- green
- red
teams-devices_device-dex-test-schemas-http:
type: object
required:
- name
- interval
- enabled
- data
properties:
data:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-data'
description:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-description'
enabled:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-enabled'
interval:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-interval'
name:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-name'
custom-pages_state:
type: string
description: The custom page state.
enum:
- default
- customized
example: default
images_images_list_response:
allOf:
- $ref: '#/components/schemas/images_api-response-common'
- properties:
result:
type: object
properties:
images:
type: array
items:
$ref: '#/components/schemas/images_image'
teams-devices_revoked_at:
type: string
format: date-time
description: When the device was revoked.
example: '2017-06-14T00:00:00Z'
tls-certificates-and-hostnames_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
messages:
$ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
cloudforce-one_priority-edit:
type: object
title: Priority Editable Attributes
required:
- labels
- priority
- requirement
- tlp
properties:
labels:
$ref: '#/components/schemas/cloudforce-one_labels'
priority:
type: integer
description: Priority
example: 1
requirement:
type: string
description: Requirement
example: DoS attacks carried out by CVEs
tlp:
$ref: '#/components/schemas/cloudforce-one_tlp'
tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on:
type: string
format: date-time
description: When the certificate expires.
example: '2122-10-29T16:59:47Z'
readOnly: true
stream_input_rtmps_url:
type: string
description: The RTMPS URL you provide to the broadcaster, which they stream live video to.
example: rtmps://live.cloudflare.com:443/live/
access_cors_headers:
type: object
properties:
allow_all_headers:
$ref: '#/components/schemas/access_allow_all_headers'
allow_all_methods:
$ref: '#/components/schemas/access_allow_all_methods'
allow_all_origins:
$ref: '#/components/schemas/access_allow_all_origins'
allow_credentials:
$ref: '#/components/schemas/access_allow_credentials'
allowed_headers:
$ref: '#/components/schemas/access_allowed_headers'
allowed_methods:
$ref: '#/components/schemas/access_allowed_methods'
allowed_origins:
$ref: '#/components/schemas/access_allowed_origins'
max_age:
$ref: '#/components/schemas/access_max_age'
magic_modified_tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_gre_tunnels:
type: array
items:
$ref: '#/components/schemas/magic_gre-tunnel'
stream_media_state:
type: string
description: Specifies the processing status for all quality levels for a video.
enum:
- pendingupload
- downloading
- queued
- inprogress
- ready
- error
example: inprogress
tunnel_status:
type: string
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
access_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/access_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/access_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic-transit_colo_name:
type: string
description: Source colo name.
example: den01
access_single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_organizations'
registrar-api_domain_response_single:
allOf:
- $ref: '#/components/schemas/registrar-api_api-response-single'
- properties:
result:
type: object
load-balancing_preview_result:
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
load-balancing_search_params:
type: object
properties:
query:
type: string
description: Search query term.
default: ''
example: primary
references:
type: string
description: The type of references to include ("*" for all).
enum:
- ''
- '*'
- referral
- referrer
default: ''
example: '*'
load-balancing_port:
type: integer
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).'
default: 0
digital-experience-monitoring_since_minutes:
type: number
description: Number of minutes before current time
default: 10
example: 10
minimum: 1
maximum: 60
teams-devices_sentinelone_s2s_input_request:
type: object
title: SentinelOne S2S Input
required:
- connection_id
properties:
active_threats:
type: number
description: The Number of active threats.
example: 1
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
infected:
type: boolean
description: Whether device is infected.
example: true
is_active:
type: boolean
description: Whether device is active.
example: true
network_status:
type: string
description: Network status of device.
enum:
- connected
- disconnected
- disconnecting
- connecting
example: connected
operator:
type: string
description: operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
zero-trust-gateway_fips-settings:
type: object
description: FIPS settings.
properties:
tls:
type: boolean
description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
example: true
access_linkedin:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
$ref: '#/components/schemas/access_generic-oauth-config'
type: object
title: LinkedIn
magic-transit_packets_ttl:
type: integer
description: The time to live (TTL).
intel_domain-history:
properties:
categorizations:
type: array
items:
type: object
properties:
categories:
example:
- id: 155
name: Technology
end:
type: string
format: date
example: '2021-04-30'
start:
type: string
format: date
example: '2021-04-01'
domain:
$ref: '#/components/schemas/intel_domain_name'
vectorize_index-upsert-response:
type: object
properties:
count:
type: integer
description: Specifies the count of the vectors successfully inserted.
example: 768
ids:
type: array
description: Array of vector identifiers of the vectors successfully inserted.
items:
$ref: '#/components/schemas/vectorize_identifier'
stream_input:
type: object
properties:
height:
type: integer
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.
width:
type: integer
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.
teams-devices_uptycs_config_request:
type: object
title: Uptycs Config
required:
- api_url
- client_key
- customer_id
- client_secret
properties:
api_url:
type: string
description: The Uptycs API URL.
example: rnd.uptycs.io
client_key:
type: string
description: The Uptycs client secret.
example: example client key
client_secret:
type: string
description: The Uptycs client secret.
example: example client secret
customer_id:
type: string
description: The Uptycs customer ID.
example: example customer id
access_schemas-empty_response:
allOf:
- properties:
result:
type: object
nullable: true
success:
type: boolean
enum:
- true
- false
example: true
secondary-dns_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/secondary-dns_acl'
zero-trust-gateway_lists:
type: object
properties:
count:
$ref: '#/components/schemas/zero-trust-gateway_count'
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
description:
$ref: '#/components/schemas/zero-trust-gateway_description'
id:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
name:
$ref: '#/components/schemas/zero-trust-gateway_name'
type:
$ref: '#/components/schemas/zero-trust-gateway_type'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
calls_api-response-single:
allOf:
- $ref: '#/components/schemas/calls_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
access_access-requests_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_access-requests'
access_active_device_count:
type: number
description: The number of active devices registered to the user.
example: 2
access_allow_all_methods:
type: boolean
description: Allows all HTTP request methods.
tunnel_schemas-connection:
properties:
client_id:
description: UUID of the cloudflared instance.
client_version:
$ref: '#/components/schemas/tunnel_version'
colo_name:
$ref: '#/components/schemas/tunnel_colo_name'
id:
$ref: '#/components/schemas/tunnel_connection_id'
is_pending_reconnect:
$ref: '#/components/schemas/tunnel_is_pending_reconnect'
opened_at:
type: string
format: date-time
description: Timestamp of when the connection was established.
example: '2021-01-25T18:22:34.317854Z'
origin_ip:
type: string
description: The public IP address of the host running cloudflared.
example: 85.12.78.6
uuid:
$ref: '#/components/schemas/tunnel_connection_id'
zero-trust-gateway_schemas-name:
type: string
description: The name of the location.
example: Austin Office Location
access_google-apps:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
apps_domain:
type: string
description: Your companies TLD
example: mycompany.com
type: object
title: Google Workspace
access_app_launcher_visible:
type: boolean
description: Displays the application in the App Launcher.
default: true
example: true
registrar-api_address:
type: string
description: Address.
example: 123 Sesame St.
teams-devices_email:
type: string
description: The contact email address of the user.
example: user@example.com
maxLength: 90
magic_site:
type: object
properties:
connector_id:
$ref: '#/components/schemas/magic_connector-id'
description:
type: string
ha_mode:
type: boolean
description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
example: true
id:
$ref: '#/components/schemas/magic_identifier'
location:
$ref: '#/components/schemas/magic_site-location'
name:
$ref: '#/components/schemas/magic_site-name'
secondary_connector_id:
$ref: '#/components/schemas/magic_secondary-connector-id'
tunnel_api-response-single:
$ref: '#/components/schemas/tunnel_api-response-common'
vectorize_index-get-vectors-by-id-request:
type: object
properties:
ids:
type: array
description: A list of vector identifiers to retrieve from the index indicated by the path.
example:
- 5121db81354a40c6aedc3fe1ace51c59
- f90eb49c2107486abdfd78c67e853430
items:
$ref: '#/components/schemas/vectorize_identifier'
intel_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/intel_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/intel_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic_psk_metadata:
type: object
description: The PSK metadata that includes when the PSK was generated.
properties:
last_generated_on:
$ref: '#/components/schemas/magic_schemas-modified_on'
custom-pages_custom_pages_response_collection:
allOf:
- $ref: '#/components/schemas/custom-pages_api-response-collection'
- properties:
result:
type: array
items:
type: object
access_oidc_saas_app:
type: object
title: OIDC SaaS App
properties:
app_launcher_url:
type: string
description: The URL where this applications tile redirects users
example: https://example.com/login
auth_type:
type: string
description: Identifier of the authentication protocol used for the saas app. Required for OIDC.
enum:
- saml
- oidc
example: oidc
client_id:
type: string
description: The application client id
example: oidc client id
client_secret:
type: string
description: The application client secret, only returned on POST request.
example: oidc client secret
created_at:
$ref: '#/components/schemas/access_timestamp'
grant_types:
type: array
description: The OIDC flows supported by this application
example:
- authorization_code
items:
type: string
enum:
- authorization_code
- authorization_code_with_pkce
group_filter_regex:
type: string
description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
example: ^GROUP_FILTER-*$
public_key:
type: string
description: The Access public certificate that will be used to verify your identity.
example: example unique name
redirect_uris:
type: array
description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens
example:
- https://example.com
items:
type: string
scopes:
type: array
description: Define the user information shared with access
example:
- openid
- groups
- email
- profile
items:
type: string
enum:
- openid
- groups
- email
- profile
updated_at:
$ref: '#/components/schemas/access_timestamp'
stream_live_input_default_creator:
type: string
description: Sets the creator ID asssociated with this live input.
access_allowed:
type: boolean
description: The result of the authentication event.
default: false
zero-trust-gateway_proxy-endpoints_components-schemas-name:
type: string
description: The name of the proxy endpoint.
example: Devops team
stream_additionalAudio:
properties:
default:
$ref: '#/components/schemas/stream_audio_default'
label:
$ref: '#/components/schemas/stream_audio_label'
status:
$ref: '#/components/schemas/stream_audio_state'
uid:
$ref: '#/components/schemas/stream_identifier'
dns-firewall_ratelimit:
type: number
description: Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster).
example: 600
nullable: true
minimum: 100
maximum: 1000000000
intel_whois:
properties:
created_date:
type: string
format: date
example: '2009-02-17'
domain:
$ref: '#/components/schemas/intel_domain_name'
nameservers:
type: array
example:
- ns3.cloudflare.com
- ns4.cloudflare.com
- ns5.cloudflare.com
- ns6.cloudflare.com
- ns7.cloudflare.com
items:
type: string
registrant:
type: string
example: DATA REDACTED
registrant_country:
type: string
example: United States
registrant_email:
type: string
example: https://domaincontact.cloudflareregistrar.com/cloudflare.com
registrant_org:
type: string
example: DATA REDACTED
registrar:
type: string
example: Cloudflare, Inc.
updated_date:
type: string
format: date
example: '2017-05-24'
logpush_logpush_job:
type: object
nullable: true
properties:
dataset:
$ref: '#/components/schemas/logpush_dataset'
destination_conf:
$ref: '#/components/schemas/logpush_destination_conf'
enabled:
$ref: '#/components/schemas/logpush_enabled'
error_message:
$ref: '#/components/schemas/logpush_error_message'
frequency:
$ref: '#/components/schemas/logpush_frequency'
id:
$ref: '#/components/schemas/logpush_id'
last_complete:
$ref: '#/components/schemas/logpush_last_complete'
last_error:
$ref: '#/components/schemas/logpush_last_error'
logpull_options:
$ref: '#/components/schemas/logpush_logpull_options'
name:
$ref: '#/components/schemas/logpush_name'
output_options:
$ref: '#/components/schemas/logpush_output_options'
dlp_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/dlp_messages'
messages:
$ref: '#/components/schemas/dlp_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
access_certificates_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_certificates'
access_last_successful_login:
type: string
format: date-time
description: The time at which the user last successfully logged in.
example: '2020-07-01T05:20:00Z'
tunnel_tunnel-response-collection:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
anyOf:
- $ref: '#/components/schemas/tunnel_cfd_tunnel'
- $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
teams-devices_os_distro_name:
type: string
description: The Linux distro name.
example: ubuntu
teams-devices_device-managed-networks_components-schemas-name:
type: string
description: The name of the device managed network. This name must be unique.
example: managed-network-1
access_app_count:
type: integer
description: Number of apps the custom page is assigned to.
secondary-dns_response_collection:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/secondary-dns_tsig'
workers-kv_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
load-balancing_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
zero-trust-gateway_ecs-support:
type: boolean
description: True if the location needs to resolve EDNS queries.
example: false
intel_per_page:
type: number
description: Number of results per page of results.
example: 20
magic-visibility_mnm_rule_automatic_advertisement:
type: boolean
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
digital-experience-monitoring_unique_devices_response:
type: object
required:
- uniqueDevicesTotal
properties:
uniqueDevicesTotal:
type: integer
description: total number of unique devices
access_azure_group_rule:
type: object
title: Azure group
description: 'Matches an Azure group.
Requires an Azure identity provider.'
required:
- azureAD
properties:
azureAD:
type: object
required:
- id
- connection_id
properties:
connection_id:
type: string
description: The ID of your Azure identity provider.
example: ea85612a-29c8-46c2-bacb-669d65136971
id:
type: string
description: The ID of an Azure group.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
teams-devices_api-response-collection-common:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
type: object
digital-experience-monitoring_device:
type: object
required:
- colo
- deviceId
- mode
- platform
- status
- timestamp
- version
properties:
colo:
$ref: '#/components/schemas/digital-experience-monitoring_colo'
deviceId:
type: string
description: Device identifier (UUID v4)
deviceName:
type: string
description: Device identifier (human readable)
personEmail:
$ref: '#/components/schemas/digital-experience-monitoring_personEmail'
platform:
$ref: '#/components/schemas/digital-experience-monitoring_platform'
status:
$ref: '#/components/schemas/digital-experience-monitoring_status'
version:
$ref: '#/components/schemas/digital-experience-monitoring_version'
addressing_schemas-description:
type: string
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
magic_priority:
type: integer
description: Priority of the static route.
r2_bucket_location:
type: string
description: Location of the bucket
enum:
- apac
- eeur
- enam
- weur
- wnam
access_client_id:
type: string
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
iam_schemas-permissions:
type: array
description: Access permissions for this User.
readOnly: true
items:
type: string
example: '#zones:read'
maxLength: 160
zero-trust-gateway_activity-log-settings:
type: object
description: Activity log settings.
properties:
enabled:
type: boolean
description: Enable activity logging.
example: true
workers_consumer_updated:
type: object
properties:
created_on:
readOnly: true
dead_letter_queue:
example: updated-example-dlq
environment:
readOnly: true
queue_name:
readOnly: true
script_name:
readOnly: true
settings:
type: object
properties:
batch_size:
type: number
example: 100
max_retries:
$ref: '#/components/schemas/workers_max_retries'
max_wait_time_ms:
$ref: '#/components/schemas/workers_max_wait_time_ms'
stream_live_input_recording_settings:
type: object
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/stream_live_input_recording_allowedOrigins'
mode:
$ref: '#/components/schemas/stream_live_input_recording_mode'
requireSignedURLs:
$ref: '#/components/schemas/stream_live_input_recording_requireSignedURLs'
timeoutSeconds:
$ref: '#/components/schemas/stream_live_input_recording_timeoutSeconds'
zero-trust-gateway_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
load-balancing_resource_reference:
type: object
description: A reference to a load balancer resource.
properties:
reference_type:
type: string
description: When listed as a reference, the type (direction) of the reference.
enum:
- referral
- referrer
references:
type: array
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:
type: object
description: A reference to a load balancer resource.
resource_id:
example: 17b5962d775c646f3f9725cbc7a53df4
resource_name:
type: string
description: The human-identifiable name of the resource.
example: primary-dc-1
resource_type:
type: string
description: The type of the resource.
enum:
- load_balancer
- monitor
- pool
example: pool
zero-trust-gateway_app-types_components-schemas-name:
type: string
description: The name of the application or application type.
example: Facebook
magic-transit_port:
type: integer
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.
default: 0
minimum: 0
maximum: 65535
workers_compatibility_flags:
type: array
description: Opt your Worker into specific changes
items:
$ref: '#/components/schemas/workers_compatibility_flag'
dns_dns_analytics_api_time_delta:
type: string
description: Unit of time to group data by.
enum:
- all
- auto
- year
- quarter
- month
- week
- day
- hour
- dekaminute
- minute
example: hour
images_api-response-single:
allOf:
- $ref: '#/components/schemas/images_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
tls-certificates-and-hostnames_association_response_collection:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/tls-certificates-and-hostnames_associationObject'
dns_dns_analytics_api_sort:
type: string
description: A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
example: +responseCode,-queryName
dns-custom-nameservers_empty_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
maxItems: 0
items: {}
rum_rule_identifier:
type: string
description: The Web Analytics rule identifier.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
access_components-schemas-name:
type: string
description: The name of the Access group.
example: Allow devs
dlp_response_collection:
allOf:
- $ref: '#/components/schemas/dlp_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dlp_profiles'
magic_schemas-mtu:
type: integer
description: The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.
default: 1476
dns-firewall_minimum_cache_ttl:
type: number
description: Minimum DNS Cache TTL.
default: 60
example: 60
minimum: 30
maximum: 36000
magic_cloudflare_gre_endpoint:
type: string
description: The IP address assigned to the Cloudflare side of the GRE tunnel.
example: 203.0.113.1
secondary-dns_ip_range:
type: string
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
cloudforce-one_priority-list:
type: object
title: Priority List Parameters
required:
- page
- per_page
properties:
page:
type: integer
description: Page number of results
per_page:
type: integer
description: Number of results per page
example: 10
magic-transit_hop_result:
type: object
properties:
nodes:
type: array
description: An array of node objects.
items:
$ref: '#/components/schemas/magic-transit_node_result'
packets_lost:
$ref: '#/components/schemas/magic-transit_packets_lost'
packets_sent:
$ref: '#/components/schemas/magic-transit_packets_sent'
packets_ttl:
$ref: '#/components/schemas/magic-transit_packets_ttl'
teams-devices_components-schemas-uuid:
type: string
description: UUID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
access_domain:
type: string
description: The primary hostname and path that Access will secure. If the app is visible in the App Launcher dashboard, this is the domain that will be displayed.
example: test.example.com/admin
stream_tus_resumable:
type: string
description: 'Specifies the TUS protocol version. This value must be included in every upload request.
Notes: The only supported version of TUS protocol is 1.0.0.'
enum:
- 1.0.0
example: 1.0.0
stream_account_identifier:
type: string
description: The account identifier tag.
example: 023e105f4ecef8ad9ca31a8372d0c353
maxLength: 32
tunnel_warp_connector_tunnel:
type: object
description: A Warp Connector Tunnel that connects your origin to Cloudflare's edge.
properties:
account_tag:
$ref: '#/components/schemas/tunnel_cf_account_id'
connections:
$ref: '#/components/schemas/tunnel_connections'
conns_active_at:
$ref: '#/components/schemas/tunnel_conns_active_at'
conns_inactive_at:
$ref: '#/components/schemas/tunnel_conns_inactive_at'
created_at:
$ref: '#/components/schemas/tunnel_created_at'
deleted_at:
$ref: '#/components/schemas/tunnel_deleted_at'
id:
$ref: '#/components/schemas/tunnel_tunnel_id'
metadata:
$ref: '#/components/schemas/tunnel_metadata'
name:
$ref: '#/components/schemas/tunnel_tunnel_name'
status:
$ref: '#/components/schemas/tunnel_status'
tun_type:
$ref: '#/components/schemas/tunnel_tunnel_type'
intel_ipv4:
type: string
format: ipv4
example: 192.0.2.0
lists_item_asn:
type: integer
description: A non-negative 32 bit integer
example: 5567
zero-trust-gateway_schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
dlp_new_custom_entry:
type: object
title: Custom entry
description: A custom entry create payload
required:
- name
- enabled
- pattern
properties:
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
name:
type: string
description: The name of the entry.
example: Credit card (Visa)
pattern:
$ref: '#/components/schemas/dlp_pattern'
zero-trust-gateway_categories:
type: object
readOnly: true
properties:
beta:
$ref: '#/components/schemas/zero-trust-gateway_beta'
class:
$ref: '#/components/schemas/zero-trust-gateway_class'
description:
$ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
id:
$ref: '#/components/schemas/zero-trust-gateway_id'
name:
$ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
subcategories:
type: array
description: All subcategories for this category.
items:
$ref: '#/components/schemas/zero-trust-gateway_subcategory'
bill-subs-api_account_identifier: {}
addressing_address-maps:
type: object
properties:
can_delete:
$ref: '#/components/schemas/addressing_can_delete'
can_modify_ips:
$ref: '#/components/schemas/addressing_can_modify_ips'
created_at:
$ref: '#/components/schemas/addressing_timestamp'
default_sni:
$ref: '#/components/schemas/addressing_default_sni'
description:
$ref: '#/components/schemas/addressing_schemas-description'
enabled:
$ref: '#/components/schemas/addressing_enabled'
id:
$ref: '#/components/schemas/addressing_identifier'
modified_at:
$ref: '#/components/schemas/addressing_timestamp'
stream_errorReasonCode:
type: string
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
load-balancing_schemas-preview_id:
example: p1aba936b94213e5b8dca0c0dbf1f9cc
workers-kv_key:
type: object
description: A name for a value. A value stored under a given key may be retrieved via the same key.
required:
- name
properties:
expiration:
type: number
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
metadata:
$ref: '#/components/schemas/workers-kv_list_metadata'
name:
$ref: '#/components/schemas/workers-kv_key_name'
intel_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:
type: string
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/`.'
zero-trust-gateway_app_id:
type: integer
description: The identifier for this application. There is only one application per ID.
zero-trust-gateway_precedence:
type: integer
description: Precedence sets the order of your rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.
magic_wan_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
wan:
$ref: '#/components/schemas/magic_wan'
tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject'
type: object
zero-trust-gateway_rule-settings:
type: object
description: Additional settings that modify the rule's action.
properties:
add_headers:
type: object
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
allow_child_bypass:
type: boolean
description: Set by parent MSP accounts to enable their children to bypass this rule.
example: false
audit_ssh:
type: object
description: Settings for the Audit SSH action.
properties:
command_logging:
type: boolean
description: Enable to turn on SSH command logging.
example: false
biso_admin_controls:
type: object
description: Configure how browser isolation behaves.
properties:
dcp:
type: boolean
description: Set to true to enable copy-pasting.
example: false
dd:
type: boolean
description: Set to true to enable downloading.
example: false
dk:
type: boolean
description: Set to true to enable keyboard usage.
example: false
dp:
type: boolean
description: Set to true to enable printing.
example: false
du:
type: boolean
description: Set to true to enable uploading.
example: false
block_page_enabled:
type: boolean
description: Enable the custom block page.
example: true
block_reason:
type: string
description: The text describing why this block occurred, displayed on the custom block page (if enabled).
example: This website is a security risk
bypass_parent_rule:
type: boolean
description: Set by children MSP accounts to bypass their parent's rules.
example: false
check_session:
type: object
description: Configure how session check behaves.
properties:
duration:
type: string
description: Configure how fresh the session needs to be to be considered valid.
example: 300s
enforce:
type: boolean
description: Set to true to enable session enforcement.
example: true
dns_resolvers:
type: object
description: Add your own custom resolvers to route queries that match the resolver policy. Cannot be used when resolve_dns_through_cloudflare is set. DNS queries will route to the address closest to their origin.
properties:
ipv4:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings'
ipv6:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_dns_resolver_settings'
egress:
type: object
description: Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs.
properties:
ipv4:
type: string
description: The IPv4 address to be used for egress.
example: 192.0.2.2
ipv4_fallback:
type: string
description: The fallback 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 egress via WARP IPs.
example: 192.0.2.3
ipv6:
type: string
description: The IPv6 range to be used for egress.
example: 2001:DB8::/64
insecure_disable_dnssec_validation:
type: boolean
description: INSECURE - disable DNSSEC validation (for Allow actions).
example: false
ip_categories:
type: boolean
description: Set to true to enable IPs in DNS resolver category blocks. By default categories only block based on domain names.
example: true
ip_indicator_feeds:
type: boolean
description: Set to true to include IPs in DNS resolver indicator feed blocks. By default indicator feeds only block based on domain names.
example: true
l4override:
type: object
description: Send matching traffic to the supplied destination IP address and port.
properties:
ip:
type: string
description: IPv4 or IPv6 address.
example: 1.1.1.1
port:
type: integer
description: A port number to use for TCP/UDP overrides.
notification_settings:
type: object
description: Configure a notification to display on the user's device when this rule is matched.
properties:
enabled:
type: boolean
description: Set notification on
msg:
type: string
description: Customize the message shown in the notification.
support_url:
type: string
description: Optional URL to direct users to additional information. If not set, the notification will open a block page.
override_host:
type: string
description: Override matching DNS queries with a hostname.
example: example.com
override_ips:
type: array
description: Override matching DNS queries with an IP or set of IPs.
example:
- 1.1.1.1
- 2.2.2.2
items:
type: string
description: IPv4 or IPv6 address.
example: 1.1.1.1
payload_log:
type: object
description: Configure DLP payload logging.
properties:
enabled:
type: boolean
description: Set to true to enable DLP payload logging for this rule.
example: true
resolve_dns_through_cloudflare:
type: boolean
description: Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot be set when dns_resolvers are specified.
example: true
untrusted_cert:
type: object
description: Configure behavior when an upstream cert is invalid or an SSL error occurs.
properties:
action:
type: string
description: The action performed when an untrusted certificate is seen. The default action is an error with HTTP code 526.
enum:
- pass_through
- block
- error
example: error
stream_input_rtmps_stream_key:
type: string
description: The secret key to use when streaming via RTMPS to a live input.
example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
vectorize_index-query-request:
type: object
properties:
returnMetadata:
type: boolean
description: Whether to return the metadata associated with the closest vectors.
default: false
returnValues:
type: boolean
description: Whether to return the values associated with the closest vectors.
default: false
topK:
type: number
description: The number of nearest neighbors to find.
default: 5
example: 5
vector:
type: array
description: The search vector that will be used to find the nearest neighbors.
example:
- 0.5
- 0.5
- 0.5
items:
type: number
addressing_default_sni:
type: string
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
rulesets_Message:
type: object
title: Message
description: A message.
required:
- message
properties:
code:
type: integer
title: Code
description: A unique code for this message.
example: 10000
message:
type: string
title: Description
description: A text description of this message.
example: something bad happened
minLength: 1
source:
type: object
title: Source
description: The source of this message.
required:
- pointer
properties:
pointer:
type: string
title: Pointer
description: A JSON pointer to the field that is the source of the message.
example: /rules/0/action
minLength: 1
aaa_secret:
type: string
description: Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.
secondary-dns_acl_components-schemas-name:
type: string
description: The name of the acl.
example: my-acl-1
magic_vlan_tag:
type: integer
description: VLAN port number.
example: 0
magic_route_update_request:
allOf:
- $ref: '#/components/schemas/magic_route_add_single_request'
zero-trust-gateway_empty_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
type: object
teams-devices_schemas-config_response:
oneOf:
- $ref: '#/components/schemas/teams-devices_tls_config_response'
type: object
description: The configuration object containing information for the WARP client to detect the managed network.
example:
sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
tls_sockaddr: foo.bar:1234
zero-trust-gateway_extended-email-matching:
type: object
description: Extended e-mail matching settings.
properties:
enabled:
type: boolean
description: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
example: true
digital-experience-monitoring_colo:
type: string
description: Cloudflare colo
example: SJC
magic-visibility_pcaps_type:
type: string
description: The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.
enum:
- simple
- full
example: simple
load-balancing_address:
type: string
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
r2_enable_sippy_gcs:
properties:
destination:
type: object
description: R2 bucket to copy objects to
properties:
accessKeyId:
type: string
description: 'ID of a Cloudflare API token.
This is the value labelled "Access Key ID" when creating an API
token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
Sippy will use this token when writing objects to R2, so it is
best to scope this token to the bucket you''re enabling Sippy for.
'
provider:
type: string
enum:
- r2
secretAccessKey:
type: string
description: 'Value of a Cloudflare API token.
This is the value labelled "Secret Access Key" when creating an API
token from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).
Sippy will use this token when writing objects to R2, so it is
best to scope this token to the bucket you''re enabling Sippy for.
'
source:
type: object
description: GCS bucket to copy objects from
properties:
bucket:
type: string
description: Name of the GCS bucket
clientEmail:
type: string
description: Client email of an IAM credential (ideally scoped to a single GCS bucket)
privateKey:
type: string
description: Private Key of an IAM credential (ideally scoped to a single GCS bucket)
provider:
type: string
enum:
- gcs
workers_namespace-delete-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
enum:
- null
nullable: true
images_images_stats:
type: object
properties:
count:
$ref: '#/components/schemas/images_images_stats_count'
dns_dns_analytics_api_api-response-single:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
dns_dns_analytics_api_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_pctComplete:
type: string
description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
minimum: 0
maximum: 100
stream_watermark_size:
type: number
description: The size of the image in bytes.
example: 29472
access_type:
type: string
description: The application type.
enum:
- self_hosted
- saas
- ssh
- vnc
- app_launcher
- warp
- biso
- bookmark
- dash_sso
example: self_hosted
rum_site-tag-response-single:
allOf:
- $ref: '#/components/schemas/rum_api-response-single'
- properties:
result:
type: object
properties:
site_tag:
$ref: '#/components/schemas/rum_site_tag'
magic_lan_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
lan:
$ref: '#/components/schemas/magic_lan'
aaa_schemas-name:
type: string
description: Name of the policy.
example: SSL Notification Event Policy
teams-devices_platform:
type: string
enum:
- windows
- mac
- linux
- android
- ios
example: windows
stream_audio_default:
type: boolean
description: Denotes whether the audio track will be played by default in a player.
default: false
images_image_upload_via_url:
type: object
title: Url
required:
- url
properties:
url:
type: string
description: A URL to fetch an image from origin.
example: https://example.com/path/to/logo.png
registrar-api_updated_at:
type: string
format: date-time
description: Last updated.
example: '2018-08-28T17:26:26Z'
magic-visibility_mnm_rule_packet_threshold:
type: number
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
iam_components-schemas-account:
allOf:
- $ref: '#/components/schemas/iam_account'
magic-visibility_mnm_rules_single_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/magic-visibility_mnm_rule'
access_rule:
oneOf:
- $ref: '#/components/schemas/access_email_rule'
- $ref: '#/components/schemas/access_email_list_rule'
- $ref: '#/components/schemas/access_domain_rule'
- $ref: '#/components/schemas/access_everyone_rule'
- $ref: '#/components/schemas/access_ip_rule'
- $ref: '#/components/schemas/access_ip_list_rule'
- $ref: '#/components/schemas/access_certificate_rule'
- $ref: '#/components/schemas/access_access_group_rule'
- $ref: '#/components/schemas/access_azure_group_rule'
- $ref: '#/components/schemas/access_github_organization_rule'
- $ref: '#/components/schemas/access_gsuite_group_rule'
- $ref: '#/components/schemas/access_okta_group_rule'
- $ref: '#/components/schemas/access_saml_group_rule'
- $ref: '#/components/schemas/access_service_token_rule'
- $ref: '#/components/schemas/access_any_valid_service_token_rule'
- $ref: '#/components/schemas/access_external_evaluation_rule'
- $ref: '#/components/schemas/access_country_rule'
- $ref: '#/components/schemas/access_authentication_method_rule'
- $ref: '#/components/schemas/access_device_posture_rule'
type: object
zero-trust-gateway_class:
type: string
description: Which account types are allowed to create policies based on this category. `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
magic_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/magic_messages'
messages:
$ref: '#/components/schemas/magic_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
access_schemas-name:
type: string
description: The name of the identity provider, shown to users on the login page.
example: Widget Corps IDP
zero-trust-gateway_ips:
type: array
description: A list of CIDRs to restrict ingress connections.
items:
type: string
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
magic_route_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_route:
type: object
dlp_DatasetNewVersionResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetNewVersion'
tunnel_client_id:
type: string
description: UUID of the Cloudflare Tunnel client.
example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
readOnly: true
maxLength: 36
access_id:
type: string
description: The ID of the CA.
example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9
readOnly: true
maxLength: 48
tunnel_config_response_single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: object
dns-custom-nameservers_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/dns-custom-nameservers_messages'
messages:
$ref: '#/components/schemas/dns-custom-nameservers_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
rum_modify-rules-request:
type: object
properties:
delete_rules:
type: array
description: A list of rule identifiers to delete.
items:
$ref: '#/components/schemas/rum_rule_identifier'
rules:
type: array
description: A list of rules to create or update.
items:
type: object
properties:
host:
type: string
example: example.com
id:
$ref: '#/components/schemas/rum_rule_identifier'
inclusive:
type: boolean
example: true
is_paused:
type: boolean
example: false
paths:
type: array
example:
- '*'
items:
type: string
load-balancing_subdivision_code_a2:
type: string
description: Two-letter subdivision code followed in ISO 3166-2.
example: CA
tunnel_config:
type: object
description: The tunnel configuration and ingress rules.
properties:
ingress:
type: array
description: List of public hostname definitions
items:
$ref: '#/components/schemas/tunnel_ingressRule'
originRequest:
$ref: '#/components/schemas/tunnel_originRequest'
warp-routing:
type: object
description: Enable private network access from WARP users to private network routes
properties:
enabled:
type: boolean
default: false
registrar-api_current_registrar:
type: string
description: Shows name of current registrar.
example: Cloudflare
magic_secondary-connector-id:
type: string
description: Magic WAN Connector identifier tag. Used when high availability mode is on.
example: 8d67040d3835dbcf46ce29da440dc482
tunnel_route_tunnel_name:
description: The user-friendly name of the Cloudflare Tunnel serving the route.
lists_lists-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
type: array
items:
allOf:
- $ref: '#/components/schemas/lists_list'
- type: object
required:
- id
- name
- kind
- num_items
- created_on
- modified_on
type: object
tunnel_existed_at:
type: string
format: date-time
description: If provided, include only tunnels that were created (and not deleted) before this time.
example: '2019-10-12T07:20:50.52Z'
access_ip_rule:
type: object
title: IP ranges
description: Matches an IP address block.
required:
- ip
properties:
ip:
type: object
required:
- ip
properties:
ip:
type: string
description: An IPv4 or IPv6 CIDR block.
example: 2400:cb00:21:10a::/64
access_bookmarks:
type: object
properties:
app_launcher_visible:
$ref: '#/components/schemas/access_schemas-app_launcher_visible'
created_at:
$ref: '#/components/schemas/access_timestamp'
domain:
$ref: '#/components/schemas/access_schemas-domain'
id:
description: The unique identifier for the Bookmark application.
logo_url:
$ref: '#/components/schemas/access_logo_url'
name:
$ref: '#/components/schemas/access_bookmarks_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
images_image_variant_options:
type: object
description: Allows you to define image resizing sizes for different use cases.
required:
- fit
- metadata
- width
- height
properties:
fit:
$ref: '#/components/schemas/images_image_variant_fit'
height:
$ref: '#/components/schemas/images_image_variant_height'
metadata:
$ref: '#/components/schemas/images_image_variant_schemas_metadata'
width:
$ref: '#/components/schemas/images_image_variant_width'
aaa_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
lists_description:
type: string
description: An informative summary of the list.
example: This is a note
maxLength: 500
stream_deleted_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: string
example: ok
workers_stepped_migrations:
allOf:
- $ref: '#/components/schemas/workers_migration_tag_conditions'
- type: object
properties:
steps:
type: array
description: Migrations to apply in order.
items:
$ref: '#/components/schemas/workers_migration_step'
images_image_variant_patch_request:
type: object
required:
- options
properties:
neverRequireSignedURLs:
$ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
options:
$ref: '#/components/schemas/images_image_variant_options'
access_user_seat_expiration_inactive_time:
type: string
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
workers_mtls_cert_binding:
type: object
required:
- name
- type
- certificate
properties:
certificate_id:
type: string
description: ID of the certificate to bind to
example: efwu2n6s-q69d-2kr9-184j-4913e8h391k6
name:
$ref: '#/components/schemas/workers_binding_name'
type:
type: string
description: The class of resource that the binding provides.
enum:
- mtls_certificate
example: mtls_certificate
cloudforce-one_request-message-list:
type: object
title: Request Message List Parameters
required:
- page
- per_page
properties:
after:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve messages created after this time
- example: '2022-01-01T00:00:00Z'
before:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve messages created before this time
- example: '2024-01-01T00:00:00Z'
page:
type: integer
description: Page number of results
per_page:
type: integer
description: Number of results per page
example: 10
sort_by:
type: string
description: Field to sort results by
example: created
sort_order:
type: string
description: Sort order (asc or desc)
enum:
- asc
- desc
tls-certificates-and-hostnames_ca:
type: boolean
description: Indicates whether the certificate is a CA or leaf certificate.
example: true
magic-visibility_pcaps_request_full:
type: object
required:
- time_limit
- type
- system
- colo_name
- destination_conf
properties:
byte_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_byte_limit'
colo_name:
$ref: '#/components/schemas/magic-visibility_pcaps_colo_name'
destination_conf:
$ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
filter_v1:
$ref: '#/components/schemas/magic-visibility_pcaps_filter_v1'
packet_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_packet_limit'
system:
$ref: '#/components/schemas/magic-visibility_pcaps_system'
time_limit:
$ref: '#/components/schemas/magic-visibility_pcaps_time_limit'
type:
$ref: '#/components/schemas/magic-visibility_pcaps_type'
pages_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/pages_messages'
messages:
$ref: '#/components/schemas/pages_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
dlp_ContextAwareness:
type: object
description: Scan the context of predefined entries to only return matches surrounded by keywords.
required:
- enabled
- skip
properties:
enabled:
type: boolean
description: If true, scan the context of predefined entries to only return matches surrounded by keywords.
skip:
$ref: '#/components/schemas/dlp_SkipConfig'
dns_dns_analytics_api_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/dns_dns_analytics_api_messages'
messages:
$ref: '#/components/schemas/dns_dns_analytics_api_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_site-location:
type: object
description: Location of site in latitude and longitude.
properties:
lat:
type: string
description: Latitude
example: 37.6192
lon:
type: string
description: Longitude
example: 122.3816
cloudforce-one_message-content:
type: string
description: Content of message
example: Can you elaborate on the type of DoS that occurred?
calls_name:
type: string
description: A short description of Calls app, not shown to end users.
default: ''
example: production-realtime-app
workers_object:
type: object
properties:
hasStoredData:
type: boolean
description: Whether the Durable Object has stored data.
example: true
readOnly: true
id:
type: string
description: ID of the Durable Object.
example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8
readOnly: true
calls_app_response_single_with_secret:
allOf:
- $ref: '#/components/schemas/calls_api-response-single'
- properties:
result:
$ref: '#/components/schemas/calls_app_with_secret'
stream_include_counts:
type: boolean
description: Includes the total number of videos associated with the submitted query parameters.
default: false
example: true
stream_output_streamKey:
type: string
description: The streamKey used to authenticate against an output's target.
example: uzya-f19y-g2g9-a2ee-51j2
intel_phishing-url-submit_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_phishing-url-submit'
access_allowed_methods:
type: array
description: Allowed HTTP request methods.
example:
- GET
items:
type: string
enum:
- GET
- POST
- HEAD
- PUT
- DELETE
- CONNECT
- OPTIONS
- TRACE
- PATCH
workers_max_wait_time_ms:
type: number
example: 5000
teams-devices_device_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
workers-kv_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
aaa_url:
type: string
description: The POST endpoint to call when dispatching a notification.
example: https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd
magic-transit_min_rtt_ms:
type: number
description: Minimum RTT in ms.
intel_permissions_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_permissions_update'
workers_namespace_identifier:
type: string
description: Namespace identifier tag.
example: 0f2ac74b498b48028cb68387c421e279
readOnly: true
maxLength: 32
digital-experience-monitoring_fleet_status_live_response:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-single'
- type: object
properties:
result:
type: object
properties:
deviceStats:
type: object
properties:
byColo:
type: array
nullable: true
items:
$ref: '#/components/schemas/digital-experience-monitoring_live_stat'
byMode:
type: array
nullable: true
items:
$ref: '#/components/schemas/digital-experience-monitoring_live_stat'
byPlatform:
type: array
nullable: true
items:
$ref: '#/components/schemas/digital-experience-monitoring_live_stat'
byStatus:
type: array
nullable: true
items:
$ref: '#/components/schemas/digital-experience-monitoring_live_stat'
byVersion:
type: array
nullable: true
items:
$ref: '#/components/schemas/digital-experience-monitoring_live_stat'
uniqueDevicesTotal:
$ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal'
email_addresses:
allOf:
- $ref: '#/components/schemas/email_destination_address_properties'
type: object
access_apps_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_apps'
logpush_dataset:
type: string
description: Name of the dataset.
example: http_requests
nullable: true
maxLength: 256
pattern: ^[a-zA-Z0-9_\-]*$
access_policies_components-schemas-name:
type: string
description: The name of the Access policy.
example: Allow devs
dlp_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
stream_uploaded:
type: string
format: date-time
description: The date and time the media item was uploaded.
example: '2014-01-02T02:20:00Z'
magic_lan_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_lan:
$ref: '#/components/schemas/magic_lan'
iam_role_components-schemas-identifier:
type: string
description: Role identifier tag.
example: 3536bcfad5faccb999b47003c79917fb
maxLength: 32
aaa_enabled:
type: boolean
description: Whether or not the Notification policy is enabled.
default: true
example: true
intel_ip:
anyOf:
- $ref: '#/components/schemas/intel_ipv4'
- $ref: '#/components/schemas/intel_ipv6'
magic_gre-tunnel:
type: object
required:
- name
- customer_gre_endpoint
- cloudflare_gre_endpoint
- interface_address
properties:
cloudflare_gre_endpoint:
$ref: '#/components/schemas/magic_cloudflare_gre_endpoint'
created_on:
$ref: '#/components/schemas/magic_schemas-created_on'
customer_gre_endpoint:
$ref: '#/components/schemas/magic_customer_gre_endpoint'
description:
$ref: '#/components/schemas/magic_schemas-description'
health_check:
$ref: '#/components/schemas/magic_health_check'
id:
$ref: '#/components/schemas/magic_schemas-identifier'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
modified_on:
$ref: '#/components/schemas/magic_schemas-modified_on'
mtu:
$ref: '#/components/schemas/magic_mtu'
name:
$ref: '#/components/schemas/magic_name'
ttl:
$ref: '#/components/schemas/magic_ttl'
teams-devices_captive_portal:
type: number
description: Turn on the captive portal after the specified amount of time.
example: 180
rum_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
security-center_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/security-center_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/security-center_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
stream_input_srt_stream_passphrase:
type: string
description: The secret key to use when streaming via SRT to a live input.
example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
stream_oneTimeUploadExpiry:
type: string
format: date-time
description: The date and time when the video upload URL is no longer valid for direct user uploads.
example: '2014-01-02T02:20:00Z'
zero-trust-gateway_components-schemas-description:
type: string
description: A short summary of domains in the category.
example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.
stream_live_input_recording_requireSignedURLs:
type: boolean
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.
default: false
example: true
stream_webhook_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
security-center_valueCountsResponse:
allOf:
- $ref: '#/components/schemas/security-center_api-response-common'
- properties:
result:
anyOf:
- type: array
items:
type: object
properties:
count:
type: integer
example: 1
value:
type: string
load-balancing_schemas-name:
type: string
description: A human-identifiable name for the origin.
example: app-server-1
access_app_uid:
description: The unique identifier for the Access application.
example: df7e2w5f-02b7-4d9d-af26-8d1988fca630
calls_app_with_secret:
type: object
properties:
created:
$ref: '#/components/schemas/calls_created'
modified:
$ref: '#/components/schemas/calls_modified'
name:
$ref: '#/components/schemas/calls_name'
secret:
$ref: '#/components/schemas/calls_secret'
uid:
$ref: '#/components/schemas/calls_identifier'
tunnel_route:
type: object
properties:
comment:
$ref: '#/components/schemas/tunnel_comment'
created_at:
description: Timestamp of when the route was created.
deleted_at:
type: string
format: date-time
description: Timestamp of when the route was deleted. If `null`, the route has not been deleted.
example: '2021-01-25T18:22:34.317854Z'
nullable: true
readOnly: true
id:
$ref: '#/components/schemas/tunnel_route_id'
network:
$ref: '#/components/schemas/tunnel_ip_network'
tunnel_id:
$ref: '#/components/schemas/tunnel_route_tunnel_id'
virtual_network_id:
$ref: '#/components/schemas/tunnel_route_virtual_network_id'
security-center_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
registrar-api_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
tunnel_route_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.
registrar-api_contact_identifier:
type: string
description: Contact Identifier.
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
maxLength: 32
workers_script-response-single:
allOf:
- $ref: '#/components/schemas/workers_api-response-single'
- properties:
result:
$ref: '#/components/schemas/workers_script-response'
teams-devices_os_distro_revision:
type: string
description: The Linux distro revision.
example: 1.0.0
magic_psk_generation_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
ipsec_tunnel_id:
$ref: '#/components/schemas/magic_identifier'
psk:
$ref: '#/components/schemas/magic_psk'
psk_metadata:
$ref: '#/components/schemas/magic_psk_metadata'
registrar-api_created_at:
type: string
format: date-time
description: Shows time of creation.
example: '2018-08-28T17:26:26Z'
vectorize_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/vectorize_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/vectorize_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
load-balancing_search:
type: object
properties:
resources:
type: array
description: A list of resources matching the search query.
items:
$ref: '#/components/schemas/load-balancing_resource_reference'
cloudforce-one_request-summary:
type: string
description: Brief description of the request
example: DoS attack
tunnel_tunnel_name:
type: string
description: A user-friendly name for the tunnel.
example: blog
magic-visibility_api-response-collection:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/magic-visibility_result_info'
type: object
cloudforce-one_request-constants:
type: object
title: Request Constants
properties:
priority:
type: array
example:
- routine
- high
- urgent
items:
$ref: '#/components/schemas/cloudforce-one_priority'
status:
type: array
example:
- open
- accepted
- reported
- approved
- completed
- declined
items:
$ref: '#/components/schemas/cloudforce-one_request-status'
tlp:
type: array
example:
- clear
- green
- amber
- amber-strict
- red
items:
$ref: '#/components/schemas/cloudforce-one_tlp'
aaa_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/aaa_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/aaa_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
magic_api-response-single:
allOf:
- $ref: '#/components/schemas/magic_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
dlp_allowed_match_count:
type: number
description: Related DLP policies will trigger when the match count exceeds the number set.
default: 0
example: 5
minimum: 0
maximum: 1000
magic_route_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_route:
type: object
cloudforce-one_request-list:
type: object
title: Request List Parameters
required:
- page
- per_page
properties:
completed_after:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve requests completed after this time
- example: '2022-01-01T00:00:00Z'
completed_before:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve requests completed before this time
- example: '2024-01-01T00:00:00Z'
created_after:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve requests created after this time
- example: '2022-01-01T00:00:00Z'
created_before:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Retrieve requests created before this time
- example: '2024-01-01T00:00:00Z'
page:
type: integer
description: Page number of results
per_page:
type: integer
description: Number of results per page
example: 10
request_type:
$ref: '#/components/schemas/cloudforce-one_request-type'
sort_by:
type: string
description: Field to sort results by
example: created
sort_order:
type: string
description: Sort order (asc or desc)
enum:
- asc
- desc
status:
$ref: '#/components/schemas/cloudforce-one_request-status'
iam_member:
type: object
required:
- id
- user
- status
- roles
properties:
id:
$ref: '#/components/schemas/iam_membership_components-schemas-identifier'
roles:
type: array
description: Roles assigned to this member.
items:
$ref: '#/components/schemas/iam_role'
status:
readOnly: true
user:
type: object
readOnly: true
required:
- email
properties:
email:
$ref: '#/components/schemas/iam_email'
first_name:
$ref: '#/components/schemas/iam_first_name'
id:
$ref: '#/components/schemas/iam_common_components-schemas-identifier'
last_name:
$ref: '#/components/schemas/iam_last_name'
two_factor_authentication_enabled:
$ref: '#/components/schemas/iam_two_factor_authentication_enabled'
bill-subs-api_current_period_end:
type: string
format: date-time
description: The end of the current period and also when the next billing is due.
example: '2014-03-31T12:20:00Z'
readOnly: true
dns_dns_analytics_api_until:
type: string
format: date-time
description: End date and time of requesting data period in ISO 8601 format.
example: '2023-11-11T13:00:00Z'
magic-visibility_pcaps_ownership_request:
type: object
required:
- destination_conf
properties:
destination_conf:
$ref: '#/components/schemas/magic-visibility_pcaps_destination_conf'
access_generic-oauth-config:
type: object
properties:
client_id:
type: string
description: Your OAuth Client ID
example:
client_secret:
type: string
description: Your OAuth Client Secret
example:
intel-sinkholes_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
vectorize_index-metric:
type: string
description: Specifies the type of metric to use calculating distance.
enum:
- cosine
- euclidean
- dot-product
secondary-dns_schemas-name:
type: string
description: TSIG key name.
example: tsig.customer.cf.
teams-devices_firewall_input_request:
type: object
title: Firewall
required:
- operating_system
- enabled
properties:
enabled:
type: boolean
description: Enabled
example: true
operating_system:
type: string
description: Operating System
enum:
- windows
- mac
example: windows
access_precedence:
type: integer
description: The order of execution for this policy. Must be unique for each policy.
zero-trust-gateway_list_item_response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_items'
- properties:
result_info:
type: object
properties:
count:
type: number
description: Total results returned based on your search parameters.
example: 1
page:
type: number
description: Current page within paginated list of results.
example: 1
per_page:
type: number
description: Number of results per page of results.
example: 20
total_count:
type: number
description: Total results available without any search parameters.
example: 2000
teams-devices_user:
type: object
properties:
email:
$ref: '#/components/schemas/teams-devices_email'
id:
$ref: '#/components/schemas/teams-devices_components-schemas-uuid'
name:
type: string
description: The enrolled device user's name.
example: John Appleseed
zero-trust-gateway_id:
type: integer
description: The identifier for this category. There is only one category per ID.
workers_api-response-collection:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/workers_result_info'
type: object
lists_items-list-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
$ref: '#/components/schemas/lists_items'
result_info:
type: object
properties:
cursors:
type: object
properties:
after:
type: string
example: yyy
before:
type: string
example: xxx
access_isolation_required:
type: boolean
description: Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use this feature.
default: false
example: false
lists_kind:
description: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
enum:
- ip
- redirect
- hostname
- asn
example: ip
intel_resolves_to_ref:
type: object
properties:
id:
$ref: '#/components/schemas/intel_stix_identifier'
value:
type: string
description: IP address or domain name.
example: 192.0.2.0
access_duration:
type: string
description: 'The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).'
example: 60m
registrar-api_country:
type: string
description: The country in which the user lives.
example: US
nullable: true
maxLength: 30
magic_interconnect:
type: object
properties:
colo_name:
$ref: '#/components/schemas/magic_components-schemas-name'
created_on:
$ref: '#/components/schemas/magic_schemas-created_on'
description:
$ref: '#/components/schemas/magic_interconnect_components-schemas-description'
gre:
$ref: '#/components/schemas/magic_gre'
health_check:
$ref: '#/components/schemas/magic_schemas-health_check'
id:
$ref: '#/components/schemas/magic_schemas-identifier'
interface_address:
$ref: '#/components/schemas/magic_interface_address'
modified_on:
$ref: '#/components/schemas/magic_schemas-modified_on'
mtu:
$ref: '#/components/schemas/magic_schemas-mtu'
name:
$ref: '#/components/schemas/magic_components-schemas-name'
access_aud:
type: string
description: The Application Audience (AUD) tag. Identifies the application associated with the CA.
example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
readOnly: true
maxLength: 64
security-center_products:
type: array
example:
- access
- dns
items:
type: string
aaa_uuid:
type: string
description: UUID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
magic_scope:
type: object
description: Used only for ECMP routes.
properties:
colo_names:
$ref: '#/components/schemas/magic_colo_names'
colo_regions:
$ref: '#/components/schemas/magic_colo_regions'
stream_playback:
type: object
properties:
dash:
type: string
description: DASH Media Presentation Description for the video.
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd
hls:
type: string
description: The HLS manifest for the video.
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8
iam_account_identifier: {}
dns_dns_analytics_api_since:
type: string
format: date-time
description: Start date and time of requesting data period in ISO 8601 format.
example: '2023-11-11T12:00:00Z'
registrar-api_available:
type: boolean
description: Shows if a domain is available for transferring into Cloudflare Registrar.
example: false
teams-devices_workspace_one_config_response:
type: object
description: The Workspace One Config Response.
required:
- api_url
- auth_url
- client_id
properties:
api_url:
type: string
description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
example: https://as123.awmdm.com/API
auth_url:
type: string
description: The Workspace One Authorization URL depending on your region.
example: https://na.uemauth.vmwservices.com/connect/token
client_id:
type: string
description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
example: example client id
stream_clipResponseSingle:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
$ref: '#/components/schemas/stream_clipping'
request-tracer_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/request-tracer_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/request-tracer_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
dns-firewall_attack_mitigation:
type: object
description: Attack mitigation settings.
nullable: true
properties:
enabled:
type: boolean
description: When enabled, random-prefix attacks are automatically mitigated and the upstream DNS servers protected.
example: true
only_when_origin_unhealthy:
description: Deprecated alias for "only_when_upstream_unhealthy".
deprecated: true
only_when_upstream_unhealthy:
type: boolean
description: Only mitigate attacks when upstream servers seem unhealthy.
default: true
example: false
magic_components-schemas-tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
interconnects:
type: array
items:
$ref: '#/components/schemas/magic_interconnect'
teams-devices_intune_config_request:
type: object
title: Intune Config
required:
- customer_id
- client_id
- client_secret
properties:
client_id:
type: string
description: The Intune client ID.
example: example client id
client_secret:
type: string
description: The Intune client secret.
example: example client secret
customer_id:
type: string
description: The Intune customer ID.
example: example customer id
hyperdrive_hyperdrive-with-identifier:
allOf:
- $ref: '#/components/schemas/hyperdrive_hyperdrive'
type: object
properties:
id:
$ref: '#/components/schemas/hyperdrive_identifier'
logcontrol_regions:
type: string
description: Comma-separated list of regions.
example: eu
maxLength: 256
pattern: ^[a-z,]*$
tunnel_route_tunnel_id:
description: UUID of the Cloudflare Tunnel serving the route.
cloudforce-one_priority-item:
type: object
title: Priority Item
required:
- id
- created
- updated
- labels
- priority
- requirement
- tlp
properties:
created:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Priority creation time
id:
$ref: '#/components/schemas/cloudforce-one_uuid'
labels:
$ref: '#/components/schemas/cloudforce-one_labels'
priority:
type: integer
description: Priority
example: 1
requirement:
type: string
description: Requirement
example: DoS attacks carried out by CVEs
tlp:
$ref: '#/components/schemas/cloudforce-one_tlp'
updated:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Priority last updated time
teams-devices_disk_encryption_input_request:
type: object
title: Disk Encryption
properties:
checkDisks:
$ref: '#/components/schemas/teams-devices_checkDisks'
requireAll:
$ref: '#/components/schemas/teams-devices_requireAll'
load-balancing_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
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
zero-trust-gateway_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_rules'
secondary-dns_algo:
type: string
description: TSIG algorithm.
example: hmac-sha512.
legacy-jhs_email:
type: string
description: The contact email address of the user.
example: user@example.com
maxLength: 90
aaa_policies_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_policies'
images_image_variant_public_request:
type: object
properties:
hero:
type: object
required:
- id
- options
properties:
id:
$ref: '#/components/schemas/images_image_variant_identifier'
neverRequireSignedURLs:
$ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
options:
$ref: '#/components/schemas/images_image_variant_options'
logpush_last_error:
type: string
format: date-time
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.
nullable: true
magic-visibility_pcaps_packet_limit:
type: number
description: The limit of packets contained in a packet capture.
example: 10000
minimum: 1
maximum: 10000
hyperdrive_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
digital-experience-monitoring_uuid:
type: string
description: API Resource UUID tag.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
stream_signed_token_request:
type: object
properties:
accessRules:
type: array
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/stream_accessRules'
downloadable:
type: boolean
description: The optional boolean value that enables using signed tokens to access MP4 download links for a video.
default: false
exp:
type: integer
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.
id:
type: string
description: The optional ID of a Stream signing key. If present, the `pem` field is also required.
example: ab0d4ef71g4425f8dcba9041231813000
nbf:
type: integer
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.
pem:
type: string
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=
magic_acls_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
acls:
type: array
items:
$ref: '#/components/schemas/magic_acl'
registrar-api_domain_update_properties:
type: object
properties:
auto_renew:
$ref: '#/components/schemas/registrar-api_auto_renew'
locked:
$ref: '#/components/schemas/registrar-api_locked'
privacy:
$ref: '#/components/schemas/registrar-api_privacy'
stream_width:
type: integer
description: The width of the image in pixels.
tunnel_zero_trust_connectivity_settings_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: object
properties:
icmp_proxy_enabled:
$ref: '#/components/schemas/tunnel_icmp_proxy_enabled'
offramp_warp_enabled:
$ref: '#/components/schemas/tunnel_offramp_warp_enabled'
teams-devices_created:
type: string
format: date-time
description: When the device was created.
example: '2017-06-14T00:00:00Z'
load-balancing_api-response-collection:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/load-balancing_result_info'
type: object
stream_audio_state:
type: string
description: Specifies the processing status of the video.
enum:
- queued
- ready
- error
iam_schemas-member:
allOf:
- $ref: '#/components/schemas/iam_member'
bill-subs-api_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic_schemas-modified_on:
type: string
format: date-time
description: The date and time the tunnel was last modified.
example: '2017-06-14T05:20:00Z'
readOnly: true
images_image_requireSignedURLs:
type: boolean
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.
default: false
example: true
teams-devices_domain_joined_input_request:
type: object
title: Domain Joined
required:
- operating_system
properties:
domain:
type: string
description: Domain
example: example.com
operating_system:
type: string
description: Operating System
enum:
- windows
example: windows
access_vnc_props:
allOf:
- $ref: '#/components/schemas/access_self_hosted_props'
- properties:
type:
type: string
description: The application type.
example: vnc
stream_clipping_created:
type: string
format: date-time
description: The date and time the clip was created.
example: '2014-01-02T02:20:00Z'
zero-trust-gateway_response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_lists'
stream_language:
type: string
description: The language tag in BCP 47 format.
example: tr
magic_schemas-tunnel_add_request:
allOf:
- $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
dlp_DatasetArrayResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetArray'
hyperdrive_hyperdrive-name:
type: string
example: example-hyperdrive
aaa_policies:
type: object
properties:
alert_type:
$ref: '#/components/schemas/aaa_alert_type'
created:
$ref: '#/components/schemas/aaa_timestamp'
description:
$ref: '#/components/schemas/aaa_schemas-description'
enabled:
$ref: '#/components/schemas/aaa_enabled'
filters:
$ref: '#/components/schemas/aaa_filters'
id:
$ref: '#/components/schemas/aaa_policy-id'
mechanisms:
$ref: '#/components/schemas/aaa_mechanisms'
modified:
$ref: '#/components/schemas/aaa_timestamp'
name:
$ref: '#/components/schemas/aaa_schemas-name'
teams-devices_split_tunnel:
type: object
required:
- address
- description
properties:
address:
type: string
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
description:
type: string
description: A description of the Split Tunnel item, displayed in the client UI.
example: Exclude testing domains from the tunnel
maxLength: 100
host:
type: string
description: The domain name to exclude from the tunnel. If `host` is present, `address` must not be present.
example: '*.example.com'
addressing_can_modify_ips:
type: boolean
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
access_device_posture_rule:
type: object
title: Device Posture
description: Enforces a device posture rule has run successfully
required:
- device_posture
properties:
device_posture:
type: object
required:
- integration_uid
properties:
integration_uid:
type: string
description: The ID of a device posture integration.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
workers_deployments-list-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
items:
type: array
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: {}
latest:
type: object
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
bill-subs-api_component_values:
type: array
description: The list of add-ons subscribed to.
items:
$ref: '#/components/schemas/bill-subs-api_component_value'
stream_media_metadata:
type: object
description: A user modifiable key-value store used to reference other systems of record for managing videos.
example:
name: video12345.mp4
intel_permissions-request:
properties:
account_tag:
type: string
description: The Cloudflare account tag of the account to change permissions on
example: 823f45f16fd2f7e21e1e054aga4d2859
feed_id:
type: integer
description: The ID of the feed to add/remove permissions on
example: 1
intel_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_passive-dns-by-ip'
tunnel_arch:
type: string
description: The cloudflared OS architecture used to establish this connection.
example: linux_amd64
workers_d1_binding:
type: object
required:
- id
- name
- type
- binding
properties:
binding:
$ref: '#/components/schemas/workers_binding_name'
id:
type: string
description: ID of the D1 database to bind to
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
name:
type: string
description: The name of the D1 database associated with the 'id' provided.
example: prod-database-auth
type:
type: string
description: The class of resource that the binding provides.
enum:
- d1
example: d1
teams-devices_manufacturer:
type: string
description: The device manufacturer name.
example: My phone corp
teams-devices_device-dex-test-schemas-description:
type: string
description: Additional details about the test.
example: Checks the dash endpoint every 30 minutes
workers_queue_created:
type: object
properties:
created_on:
readOnly: true
modified_on:
readOnly: true
queue_id:
readOnly: true
queue_name:
$ref: '#/components/schemas/workers_name'
logpush_logpush_job_response_single:
allOf:
- $ref: '#/components/schemas/logpush_api-response-single'
- properties:
result:
$ref: '#/components/schemas/logpush_logpush_job'
aaa_alert_body:
type: string
description: Message body included in the notification sent.
example: SSL certificate has expired
images_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/images_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/images_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
intel_risk_score:
type: number
description: Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).
lists_created_on:
type: string
description: The RFC 3339 timestamp of when the list was created.
example: '2020-01-01T08:00:00Z'
aaa_mechanisms:
type: object
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
secondary-dns_ixfr_enable:
type: boolean
description: Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.
example: false
access_policies:
type: object
properties:
approval_groups:
$ref: '#/components/schemas/access_approval_groups'
approval_required:
$ref: '#/components/schemas/access_approval_required'
created_at:
$ref: '#/components/schemas/access_timestamp'
decision:
$ref: '#/components/schemas/access_decision'
exclude:
$ref: '#/components/schemas/access_schemas-exclude'
id:
$ref: '#/components/schemas/access_uuid'
include:
$ref: '#/components/schemas/access_include'
isolation_required:
$ref: '#/components/schemas/access_isolation_required'
name:
$ref: '#/components/schemas/access_policies_components-schemas-name'
precedence:
$ref: '#/components/schemas/access_precedence'
purpose_justification_prompt:
$ref: '#/components/schemas/access_purpose_justification_prompt'
purpose_justification_required:
$ref: '#/components/schemas/access_purpose_justification_required'
require:
$ref: '#/components/schemas/access_schemas-require'
session_duration:
$ref: '#/components/schemas/access_components-schemas-session_duration'
updated_at:
$ref: '#/components/schemas/access_timestamp'
rum_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
load-balancing_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
addressing_loa_document_identifier:
type: string
description: Identifier for the uploaded LOA document.
example: d933b1530bc56c9953cf8ce166da8004
nullable: true
maxLength: 32
access_schemas-identifier:
example: 699d98642c564d2e855e9661899b7252
access_api-response-single:
allOf:
- $ref: '#/components/schemas/access_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
stream_key_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
type: object
properties:
created:
$ref: '#/components/schemas/stream_signing_key_created'
id:
$ref: '#/components/schemas/stream_schemas-identifier'
tunnel_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
cloudforce-one_api-response-common-failure:
allOf:
- $ref: '#/components/schemas/cloudforce-one_api-response-common'
- properties:
errors:
example:
code: 10433
message: request error
success:
example: false
dlp_DatasetUpload:
type: object
required:
- version
- status
- num_cells
properties:
num_cells:
type: integer
format: int64
status:
$ref: '#/components/schemas/dlp_DatasetUploadStatus'
version:
type: integer
format: int64
load-balancing_consecutive_down:
type: integer
description: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
default: 0
magic-visibility_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/magic-visibility_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/magic-visibility_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
stream_output_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_output'
teams-devices_single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-posture-rules'
stream_playback_webrtc:
type: object
description: Details for playback from a live input using WebRTC.
properties:
url:
$ref: '#/components/schemas/stream_playback_webrtc_url'
iam_api-response-collection:
allOf:
- $ref: '#/components/schemas/iam_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/iam_result_info'
type: object
hyperdrive_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
workers_zone_name:
type: string
description: Name of the zone.
example: example.com
registrar-api_domain_properties:
type: object
properties:
available:
$ref: '#/components/schemas/registrar-api_available'
can_register:
$ref: '#/components/schemas/registrar-api_can_register'
created_at:
$ref: '#/components/schemas/registrar-api_created_at'
current_registrar:
$ref: '#/components/schemas/registrar-api_current_registrar'
expires_at:
$ref: '#/components/schemas/registrar-api_expires_at'
id:
$ref: '#/components/schemas/registrar-api_domain_identifier'
locked:
$ref: '#/components/schemas/registrar-api_locked'
registrant_contact:
$ref: '#/components/schemas/registrar-api_registrant_contact'
registry_statuses:
$ref: '#/components/schemas/registrar-api_registry_statuses'
supported_tld:
$ref: '#/components/schemas/registrar-api_supported_tld'
transfer_in:
$ref: '#/components/schemas/registrar-api_transfer_in'
updated_at:
$ref: '#/components/schemas/registrar-api_updated_at'
magic_site_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_site:
$ref: '#/components/schemas/magic_site'
stream_playback_srt_stream_passphrase:
type: string
description: The secret key to use for playback via SRT.
example: 2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada
digital-experience-monitoring_live_stat:
type: object
properties:
uniqueDevicesTotal:
$ref: '#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal'
value:
type: string
access_schemas-access_seat:
type: boolean
description: True if the user has authenticated with Cloudflare Access.
example: false
bill-subs-api_account_subscription_response_single:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-single'
- type: object
properties:
result:
type: object
stream_playback_webrtc_url:
type: string
description: The URL used to play live video over WebRTC.
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play
access_single_response_without_html:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_custom_page_without_html'
aaa_history:
type: object
properties:
alert_body:
$ref: '#/components/schemas/aaa_alert_body'
alert_type:
$ref: '#/components/schemas/aaa_schemas-alert_type'
description:
$ref: '#/components/schemas/aaa_components-schemas-description'
id:
$ref: '#/components/schemas/aaa_uuid'
mechanism:
$ref: '#/components/schemas/aaa_mechanism'
mechanism_type:
$ref: '#/components/schemas/aaa_mechanism_type'
name:
$ref: '#/components/schemas/aaa_schemas-name'
policy_id:
$ref: '#/components/schemas/aaa_policy-id'
sent:
$ref: '#/components/schemas/aaa_sent'
load-balancing_schemas-identifier:
type: string
example: 17b5962d775c646f3f9725cbc7a53df4
intel_popularity_rank:
type: integer
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.
access_ip_list_rule:
type: object
title: IP list
description: Matches an IP address from a list.
required:
- ip_list
properties:
ip_list:
type: object
required:
- id
properties:
id:
type: string
description: The ID of a previously created IP list.
example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
addressing_advertised:
type: boolean
description: Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
example: true
nullable: true
access_custom-claims-support:
type: object
properties:
claims:
type: array
description: Custom claims
example:
- email_verified
- preferred_username
- custom_claim_name
items:
type: string
email_claim_name:
type: string
description: The claim name for email in the id_token response.
example: custom_claim_name
email_verified:
type: string
format: date-time
description: The date and time the destination address has been verified. Null means not verified yet.
example: '2014-01-02T02:20:00Z'
readOnly: true
teams-devices_revoke_devices_request:
type: array
description: A list of device ids to revoke.
maxLength: 200
items:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
teams-devices_device_settings_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device_settings_policy'
access_key_config:
type: object
properties:
days_until_next_rotation:
$ref: '#/components/schemas/access_days_until_next_rotation'
key_rotation_interval_days:
$ref: '#/components/schemas/access_key_rotation_interval_days'
last_key_rotation_at:
$ref: '#/components/schemas/access_last_key_rotation_at'
lists_items-update-request-collection:
type: array
items:
allOf:
- type: object
properties:
asn:
$ref: '#/components/schemas/lists_item_asn'
comment:
$ref: '#/components/schemas/lists_item_comment'
hostname:
$ref: '#/components/schemas/lists_item_hostname'
ip:
$ref: '#/components/schemas/lists_item_ip'
redirect:
$ref: '#/components/schemas/lists_item_redirect'
hyperdrive_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/hyperdrive_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/hyperdrive_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
stream_input_webrtc:
type: object
description: Details for streaming to a live input using WebRTC.
properties:
url:
$ref: '#/components/schemas/stream_input_webrtc_url'
workers_migration_tag_conditions:
type: object
properties:
new_tag:
type: string
description: Tag to set as the latest migration tag.
example: v2
old_tag:
type: string
description: Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
example: v1
load-balancing_monitor-editable:
type: object
properties:
allow_insecure:
$ref: '#/components/schemas/load-balancing_allow_insecure'
consecutive_down:
$ref: '#/components/schemas/load-balancing_consecutive_down'
consecutive_up:
$ref: '#/components/schemas/load-balancing_consecutive_up'
description:
$ref: '#/components/schemas/load-balancing_description'
expected_body:
$ref: '#/components/schemas/load-balancing_expected_body'
expected_codes:
$ref: '#/components/schemas/load-balancing_expected_codes'
follow_redirects:
$ref: '#/components/schemas/load-balancing_follow_redirects'
header:
$ref: '#/components/schemas/load-balancing_header'
interval:
$ref: '#/components/schemas/load-balancing_interval'
method:
$ref: '#/components/schemas/load-balancing_method'
path:
$ref: '#/components/schemas/load-balancing_path'
port:
$ref: '#/components/schemas/load-balancing_port'
probe_zone:
$ref: '#/components/schemas/load-balancing_probe_zone'
retries:
$ref: '#/components/schemas/load-balancing_retries'
timeout:
$ref: '#/components/schemas/load-balancing_timeout'
type:
$ref: '#/components/schemas/load-balancing_type'
stream_watermarks:
type: object
properties:
created:
$ref: '#/components/schemas/stream_watermark_created'
downloadedFrom:
$ref: '#/components/schemas/stream_downloadedFrom'
height:
$ref: '#/components/schemas/stream_height'
name:
$ref: '#/components/schemas/stream_name'
opacity:
$ref: '#/components/schemas/stream_opacity'
padding:
$ref: '#/components/schemas/stream_padding'
position:
$ref: '#/components/schemas/stream_position'
scale:
$ref: '#/components/schemas/stream_scale'
size:
$ref: '#/components/schemas/stream_watermark_size'
uid:
$ref: '#/components/schemas/stream_watermark_identifier'
width:
$ref: '#/components/schemas/stream_width'
stream_start:
type: string
format: date-time
description: Lists videos created after the specified date.
example: '2014-01-02T02:20:00Z'
workers-kv_schemas-result:
allOf:
- $ref: '#/components/schemas/workers-kv_result'
- properties:
data:
example:
- metrics:
- - 2
- 4
- - 16
- 32
max:
example:
readKiB: 32
requests: 4
min:
example:
readKiB: 16
requests: 2
query:
$ref: '#/components/schemas/workers-kv_query'
totals:
example:
readKiB: 48
requests: 6
teams-devices_allow_mode_switch:
type: boolean
description: Whether to allow the user to switch WARP between modes.
example: true
teams-devices_split_tunnel_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel'
logpush_logpull_options:
type: string
format: uri-reference
description: This field is deprecated. Use `output_options` instead. 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×tamps=rfc3339
nullable: true
deprecated: true
maxLength: 4096
tls-certificates-and-hostnames_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_device-posture-rules:
type: object
properties:
description:
$ref: '#/components/schemas/teams-devices_description'
expiration:
$ref: '#/components/schemas/teams-devices_expiration'
id:
$ref: '#/components/schemas/teams-devices_uuid'
input:
$ref: '#/components/schemas/teams-devices_input'
match:
$ref: '#/components/schemas/teams-devices_match'
name:
$ref: '#/components/schemas/teams-devices_name'
schedule:
$ref: '#/components/schemas/teams-devices_schedule'
type:
$ref: '#/components/schemas/teams-devices_type'
rum_create-site-request:
type: object
properties:
auto_install:
$ref: '#/components/schemas/rum_auto_install'
host:
type: string
description: The hostname to use for gray-clouded sites.
example: example.com
zone_tag:
$ref: '#/components/schemas/rum_zone_tag'
zero-trust-gateway_browser-isolation-settings:
type: object
description: Browser isolation settings.
properties:
non_identity_enabled:
type: boolean
description: Enable non-identity onramp support for Browser Isolation.
example: true
url_browser_isolation_enabled:
type: boolean
description: Enable Clientless Browser Isolation.
example: true
zero-trust-gateway_categories_components-schemas-name:
type: string
description: The name of the category.
example: Education
access_self_hosted_domains:
type: array
description: List of domains that Access will secure.
example:
- test.example.com/admin
- test.anotherexample.com/staff
items:
type: string
description: A domain that Access will secure.
digital-experience-monitoring_per_page:
type: number
description: Number of items per page
example: 10
minimum: 1
maximum: 50
digital-experience-monitoring_page:
type: number
description: Page number of paginated results
default: 1
example: 1
minimum: 1
aaa_audit-logs:
type: object
properties:
action:
type: object
properties:
result:
type: boolean
description: A boolean that indicates if the action attempted was successful.
example: true
type:
type: string
description: A short string that describes the action that was performed.
example: change_setting
actor:
type: object
properties:
email:
type: string
format: email
description: The email of the user that performed the action.
example: michelle@example.com
id:
type: string
description: The ID of the actor that performed the action. If a user performed the action, this will be their User ID.
example: f6b5de0326bb5182b8a4840ee01ec774
ip:
type: string
description: The IP address of the request that performed the action.
example: 198.41.129.166
type:
type: string
description: The type of actor, whether a User, Cloudflare Admin, or an Automated System.
enum:
- user
- admin
- Cloudflare
example: user
id:
type: string
description: A string that uniquely identifies the audit log.
example: d5b0f326-1232-4452-8858-1089bd7168ef
interface:
type: string
description: The source of the event.
example: API
metadata:
type: object
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
newValue:
type: string
description: The new value of the resource that was modified.
example: low
oldValue:
type: string
description: The value of the resource before it was modified.
example: high
owner:
type: object
properties:
id:
$ref: '#/components/schemas/aaa_identifier'
resource:
type: object
properties:
id:
type: string
description: An identifier for the resource that was affected by the action.
example: 023e105f4ecef8ad9ca31a8372d0c353
type:
type: string
description: A short string that describes the resource that was affected by the action.
example: zone
when:
type: string
format: date-time
description: A UTC RFC3339 timestamp that specifies when the action being logged occured.
example: '2017-04-26T17:31:07Z'
teams-devices_devices_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_devices'
lists_list-response-collection:
allOf:
- $ref: '#/components/schemas/lists_api-response-collection'
- type: object
properties:
result:
$ref: '#/components/schemas/lists_list'
type: object
intel_permission_list_item_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-common'
- properties:
result:
type: array
example:
- description: An important indicator list
id: 1
name: indicator_list_1
- description: An even more important indicator list
id: 2
name: indicator_list_2
items:
$ref: '#/components/schemas/intel_permission_list_item'
dns-firewall_retries:
type: number
description: Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt).
default: 2
example: 2
minimum: 0
maximum: 2
load-balancing_name:
type: string
description: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
example: primary-dc-1
workers-kv_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/workers-kv_messages'
messages:
$ref: '#/components/schemas/workers-kv_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
d1_query-result-response:
type: object
properties:
meta:
$ref: '#/components/schemas/d1_query-meta'
results:
type: array
items:
type: object
success:
type: boolean
teams-devices_uuid:
type: string
description: API UUID.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
teams-devices_fallback_domain_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_fallback_domain'
tunnel_config_src:
type: string
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
default: local
example: cloudflare
access_groups:
type: object
properties:
created_at:
$ref: '#/components/schemas/access_timestamp'
exclude:
$ref: '#/components/schemas/access_exclude'
id:
$ref: '#/components/schemas/access_uuid'
include:
$ref: '#/components/schemas/access_include'
is_default:
$ref: '#/components/schemas/access_require'
name:
$ref: '#/components/schemas/access_components-schemas-name'
require:
$ref: '#/components/schemas/access_require'
updated_at:
$ref: '#/components/schemas/access_timestamp'
zero-trust-gateway_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_locations'
registrar-api_address2:
type: string
description: Optional address line for unit, floor, suite, etc.
example: Suite 430
workers-kv_value:
type: string
description: A byte sequence to be stored, up to 25 MiB in length.
example: Some Value
tunnel_offramp_warp_enabled:
type: boolean
description: A flag to enable WARP to WARP traffic.
example: true
r2_bucket_name:
type: string
description: Name of the bucket
example: example-bucket
minLength: 3
maxLength: 64
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]
images_image_key_response_collection:
allOf:
- $ref: '#/components/schemas/images_api-response-common'
- properties:
result:
$ref: '#/components/schemas/images_image_keys_response'
logpush_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/logpush_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/logpush_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
pages_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
legacy-jhs_schemas-configuration:
oneOf:
- $ref: '#/components/schemas/legacy-jhs_ip_configuration'
- $ref: '#/components/schemas/legacy-jhs_ipv6_configuration'
- $ref: '#/components/schemas/legacy-jhs_cidr_configuration'
- $ref: '#/components/schemas/legacy-jhs_asn_configuration'
- $ref: '#/components/schemas/legacy-jhs_country_configuration'
type: object
description: The rule configuration.
magic_tunnel_update_request:
allOf:
- $ref: '#/components/schemas/magic_tunnel_add_single_request'
dns-firewall_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
tls-certificates-and-hostnames_schemas-name:
type: string
description: Optional unique name for the certificate. Only used for human readability.
example: example_ca_cert
logpush_logpush_field_response_collection:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
items:
type: object
nullable: true
properties:
key:
type: string
example: value
teams-devices_key:
type: string
description: The device's public key.
example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=
logcontrol_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
teams-devices_api-response-single:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
nullable: true
type: object
iam_single_member_response_with_code:
allOf:
- $ref: '#/components/schemas/iam_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/iam_member_with_code'
intel_count:
type: number
description: Total results returned based on your search parameters.
example: 1
lists_item_ip:
type: string
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
pages_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
access_saml:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
type: object
properties:
attributes:
type: array
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
email_attribute_name:
type: string
description: The attribute name for email in the SAML response.
example: Email
header_attributes:
type: array
description: Add a list of attribute names that will be returned in the response header from the Access callback.
items:
type: object
properties:
attribute_name:
type: string
description: attribute name from the IDP
header_name:
type: string
description: header that will be added on the request to the origin
idp_public_certs:
type: array
description: X509 certificate to verify the signature in the SAML authentication response
items:
type: string
issuer_url:
type: string
description: IdP Entity ID or Issuer URL
example: https://whoami.com
sign_request:
type: boolean
description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.
sso_target_url:
type: string
description: URL to send the SAML authentication requests to
example: https://edgeaccess.org/idp/saml/login
type: object
title: Generic SAML
workers_schemas-service:
type: string
description: Worker service associated with the zone and hostname.
example: foo
workers-kv_namespace:
type: object
required:
- id
- title
properties:
id:
$ref: '#/components/schemas/workers-kv_namespace_identifier'
supports_url_encoding:
type: boolean
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
title:
$ref: '#/components/schemas/workers-kv_namespace_title'
rum_site_token:
type: string
description: The Web Analytics site token.
example: 023e105f4ecef8ad9ca31a8372d0c353
zero-trust-gateway_schemas-single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_locations'
access_approval_required:
type: boolean
description: Requires the user to request access from an administrator at the start of each session.
default: false
example: true
registrar-api_city:
type: string
description: City.
example: Austin
intel_risk_types:
example: []
email_api-response-single:
allOf:
- $ref: '#/components/schemas/email_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
zero-trust-gateway_fail_closed:
type: boolean
description: Block requests for files that cannot be scanned.
example: false
zero-trust-gateway_proxy-endpoints_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
zero-trust-gateway_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
request-tracer_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
teams-devices_name:
type: string
description: The name of the device posture rule.
example: Admin Serial Numbers
zero-trust-gateway_application_type:
type: object
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
description:
type: string
description: A short summary of applications with this type.
example: Applications used to communicate or collaborate in a business setting.
id:
$ref: '#/components/schemas/zero-trust-gateway_app_type_id'
name:
$ref: '#/components/schemas/zero-trust-gateway_app-types_components-schemas-name'
addressing_modified_at_nullable:
type: string
format: date-time
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'
nullable: true
zero-trust-gateway_notification_settings:
type: object
description: Configure a message to display on the user's device when an antivirus search is performed.
properties:
enabled:
type: boolean
description: Set notification on
msg:
type: string
description: Customize the message shown in the notification.
support_url:
type: string
description: Optional URL to direct users to additional information. If not set, the notification will open a block page.
zero-trust-gateway_action:
type: string
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
access_timestamp:
type: string
format: date-time
example: '2014-01-01T05:20:00.12345Z'
readOnly: true
stream_live_input_metadata:
type: object
description: A user modifiable key-value store used to reference other systems of record for managing live inputs.
example:
name: test stream 1
teams-devices_override_codes_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: object
properties:
disable_for_time:
$ref: '#/components/schemas/teams-devices_disable_for_time'
registrar-api_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic-visibility_pcaps_request_pcap:
anyOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_request_simple'
- $ref: '#/components/schemas/magic-visibility_pcaps_request_full'
stream_readyToStreamAt:
type: string
format: date-time
description: Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
example: '2014-01-02T02:20:00Z'
stream_key_generation_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
$ref: '#/components/schemas/stream_keys'
stream_addAudioTrackResponse:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
$ref: '#/components/schemas/stream_additionalAudio'
d1_create-database-response:
type: object
properties:
created_at:
description: Specifies the timestamp the resource was created as an ISO8601 string.
example: '2022-11-15T18:25:44.442097Z'
readOnly: true
name:
$ref: '#/components/schemas/d1_database-name'
uuid:
$ref: '#/components/schemas/d1_database-identifier'
version:
$ref: '#/components/schemas/d1_database-version'
turnstile_invalidate_immediately:
type: boolean
description: 'If `invalidate_immediately` is set to `false`, the previous secret will
remain valid for two hours. Otherwise, the secret is immediately
invalidated, and requests using it will be rejected.
'
default: false
dns-custom-nameservers_schemas-identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
zero-trust-gateway_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/zero-trust-gateway_messages'
messages:
$ref: '#/components/schemas/zero-trust-gateway_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
access_id_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/access_uuid'
email_destination_address_identifier:
type: string
description: Destination address identifier.
example: ea95132c15732412d22c1476fa83f27a
readOnly: true
maxLength: 32
magic-transit_packet_type:
type: string
description: Type of packet sent.
enum:
- icmp
- tcp
- udp
- gre
- gre+icmp
default: icmp
example: icmp
vectorize_index-query-response:
type: object
properties:
count:
type: integer
description: Specifies the count of vectors returned by the search
matches:
type: array
description: Array of vectors matched by the search
items:
type: object
properties:
id:
$ref: '#/components/schemas/vectorize_identifier'
metadata:
type: object
score:
type: number
description: The score of the vector according to the index's distance metric
values:
type: array
items:
type: number
iam_last_name:
type: string
description: User's last name
example: Appleseed
nullable: true
maxLength: 60
addressing_cidr:
type: string
description: IP Prefix in Classless Inter-Domain Routing format.
example: 192.0.2.0/24
aaa_account-id:
type: string
description: The account id
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
iam_collection_role_response:
allOf:
- $ref: '#/components/schemas/iam_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/iam_schemas-role'
tunnel_route_response_single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/tunnel_route'
teams-devices_support_url:
type: string
description: The URL to launch when the Send Feedback button is clicked.
example: https://1.1.1.1/help
access_policy_check_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
properties:
app_state:
type: object
properties:
app_uid:
$ref: '#/components/schemas/access_uuid'
aud:
type: string
example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389
hostname:
type: string
example: test.com
name:
type: string
example: Test App
policies:
type: array
example:
- decision: allow
exclude: []
include:
- _type: email
email: testuser@gmail.com
precedence: 0
require: []
status: Success
items: {}
status:
type: string
example: Success
user_identity:
type: object
properties:
account_id:
type: string
example: 41ecfbb341f033e52b46742756aabb8b
device_sessions:
type: object
example: {}
email:
type: string
example: testuser@gmail.com
geo:
type: object
properties:
country:
type: string
example: US
iat:
type: integer
id:
type: string
example: '1164449231815010287495'
is_gateway:
type: boolean
example: false
is_warp:
type: boolean
example: false
name:
type: string
example: Test User
user_uuid:
$ref: '#/components/schemas/access_uuid'
version:
type: integer
dlp_DatasetUpdate:
type: object
properties:
description:
type: string
nullable: true
name:
type: string
nullable: true
access_biso_props:
allOf:
- $ref: '#/components/schemas/access_feature_app_props'
- properties:
domain:
example: authdomain.cloudflareaccess.com/browser
readOnly: true
name:
default: Clientless Web Isolation
example: Clientless Web Isolation
readOnly: true
type:
type: string
description: The application type.
example: biso
access_identity:
type: object
properties:
account_id:
type: string
example: '1234567890'
auth_status:
type: string
example: NONE
common_name:
type: string
example: ''
device_id:
type: string
example: ''
device_sessions:
$ref: '#/components/schemas/access_string_key_map_device_session'
devicePosture:
type: object
email:
type: string
example: test@cloudflare.com
geo:
$ref: '#/components/schemas/access_geo'
iat:
type: number
example: 1694791905
idp:
type: object
properties:
id:
type: string
type:
type: string
ip:
type: string
example: 127.0.0.0
is_gateway:
type: boolean
example: false
is_warp:
type: boolean
example: false
mtls_auth:
type: object
properties:
auth_status:
type: string
cert_issuer_dn:
type: string
cert_issuer_ski:
type: string
cert_presented:
type: boolean
cert_serial:
type: string
service_token_id:
type: string
example: ''
service_token_status:
type: boolean
example: false
user_uuid:
type: string
example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4
version:
type: number
example: 2
pages_deployment_configs_values:
type: object
properties:
ai_bindings:
type: object
description: Constellation bindings used for Pages Functions.
nullable: true
properties:
AI_BINDING:
type: object
description: AI binding.
example: {}
properties:
project_id: {}
analytics_engine_datasets:
type: object
description: Analytics Engine bindings used for Pages Functions.
nullable: true
properties:
ANALYTICS_ENGINE_BINDING:
type: object
description: Analytics Engine binding.
example:
dataset: api_analytics
properties:
dataset:
type: string
description: Name of the dataset.
example: api_analytics
browsers:
type: object
description: Browser bindings used for Pages Functions.
nullable: true
properties:
BROWSER:
type: object
description: Browser binding.
compatibility_date:
type: string
description: Compatibility date used for Pages Functions.
example: '2022-01-01'
compatibility_flags:
type: array
description: Compatibility flags used for Pages Functions.
example:
- url_standard
items: {}
d1_databases:
type: object
description: D1 databases used for Pages Functions.
nullable: true
properties:
D1_BINDING:
type: object
description: D1 binding.
example:
id: 445e2955-951a-43f8-a35b-a4d0c8138f63
properties:
id:
type: string
description: UUID of the D1 database.
example: 445e2955-951a-43f8-a35b-a4d0c8138f63
durable_object_namespaces:
type: object
description: Durabble Object namespaces used for Pages Functions.
nullable: true
properties:
DO_BINDING:
type: object
description: Durabble Object binding.
example:
namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
properties:
namespace_id:
type: string
description: ID of the Durabble Object namespace.
example: 5eb63bbbe01eeed093cb22bb8f5acdc3
env_vars:
type: object
description: Environment variables for build configs.
nullable: true
properties:
ENVIRONMENT_VARIABLE:
type: object
description: Environment variable.
example:
type: plain_text
value: hello world
properties:
type:
type: string
description: The type of environment variable (plain text or secret)
enum:
- plain_text
- secret_text
value:
type: string
description: Environment variable value.
hyperdrive_bindings:
type: object
description: Hyperdrive bindings used for Pages Functions.
nullable: true
properties:
HYPERDRIVE:
type: object
description: Hyperdrive binding.
example:
id: a76a99bc342644deb02c38d66082262a
properties:
id:
type: string
example: a76a99bc342644deb02c38d66082262a
kv_namespaces:
type: object
description: KV namespaces used for Pages Functions.
properties:
KV_BINDING:
type: object
description: KV binding.
example:
namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
properties:
namespace_id:
type: string
description: ID of the KV namespace.
example: 5eb63bbbe01eeed093cb22bb8f5acdc3
mtls_certificates:
type: object
description: mTLS bindings used for Pages Functions.
nullable: true
properties:
MTLS:
type: object
description: mTLS binding.
example:
certificate_id: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
properties:
certificate_id:
type: string
example: d7cdd17c-916f-4cb7-aabe-585eb382ec4e
placement:
type: object
description: Placement setting used for Pages Functions.
example:
mode: smart
nullable: true
properties:
mode:
type: string
description: Placement mode.
example: smart
queue_producers:
type: object
description: Queue Producer bindings used for Pages Functions.
nullable: true
properties:
QUEUE_PRODUCER_BINDING:
type: object
description: Queue Producer binding.
example:
name: some-queue
properties:
name:
type: string
description: Name of the Queue.
example: some-queue
r2_buckets:
type: object
description: R2 buckets used for Pages Functions.
nullable: true
properties:
R2_BINDING:
type: object
description: R2 binding.
example:
name: some-bucket
properties:
name:
type: string
description: Name of the R2 bucket.
example: some-bucket
services:
type: object
description: Services used for Pages Functions.
nullable: true
properties:
SERVICE_BINDING:
type: object
description: Service binding.
example:
environment: production
service: example-worker
properties:
environment:
type: string
description: The Service environment.
service:
type: string
description: The Service name.
vectorize_bindings:
type: object
description: Vectorize bindings used for Pages Functions.
nullable: true
properties:
VECTORIZE:
type: object
description: Vectorize binding.
example:
index_name: my_index
properties:
index_name:
type: string
example: my_index
access_apps_components-schemas-name:
type: string
description: The name of the application.
example: Admin Site
access_ip:
type: string
description: The IP address of the authenticating user.
example: 198.41.129.166
stream_duration:
type: number
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.
legacy-jhs_schemas-mode:
type: string
description: The action to apply to a matched request.
enum:
- block
- challenge
- whitelist
- js_challenge
- managed_challenge
example: challenge
access_custom_non_identity_deny_url:
type: string
description: The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules.
magic-visibility_pcaps_time_limit:
type: number
description: The packet capture duration in seconds.
example: 300
minimum: 1
maximum: 300
access_bookmarks_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_bookmarks'
tunnel_metadata:
type: object
description: Metadata associated with the tunnel.
example: {}
access_ca:
type: object
properties:
aud:
$ref: '#/components/schemas/access_aud'
id:
$ref: '#/components/schemas/access_id'
public_key:
$ref: '#/components/schemas/access_public_key'
dlp_profile_id:
allOf:
- $ref: '#/components/schemas/dlp_uuid'
description: The ID for this profile
example: 384e129d-25bd-403c-8019-bc19eb7a8a5f
tunnel_tunnel_secret:
type: string
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=
security-center_api-response-single:
allOf:
- $ref: '#/components/schemas/security-center_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
images_image_key_value:
type: string
description: Key value.
example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=
readOnly: true
stream_input_srt_stream_id:
type: string
description: The identifier of the live input to use when streaming via SRT.
example: f256e6ea9341d51eea64c9454659e576
magic-visibility_pcaps_ownership_challenge:
type: string
description: The ownership challenge filename stored in the bucket.
example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt
dns-firewall_api-response-single:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
pages_deployment-response-logs:
allOf:
- $ref: '#/components/schemas/pages_api-response-common'
- properties:
result:
type: object
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 -> 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
teams-devices_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-posture-integrations'
intel_application:
type: object
description: Application that the hostname belongs to.
properties:
id:
type: integer
name:
type: string
example: CLOUDFLARE
dns_dns_analytics_api_report_bytime:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_result'
- required:
- time_intervals
- query
- data
properties:
data:
items:
required:
- metrics
properties:
metrics:
type: array
description: Array with one item per requested metric. Each item is an array of values, broken down by time interval.
items:
type: array
description: Nominal metric values, broken down by time interval.
items: {}
properties:
items:
type: number
description: Nominal metric value.
query:
type: object
required:
- time_delta
properties:
time_delta:
$ref: '#/components/schemas/dns_dns_analytics_api_time_delta'
time_intervals:
type: array
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.
'
items:
type: array
description: Array with exactly two items, representing the start and end time (respectively) of this time interval.
items:
type: string
format: date-time
description: Time value.
example: '2023-11-11T12:00:00Z'
teams-devices_schedule:
type: string
description: 'Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.'
example: 1h
magic_tunnel_modified_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
modified:
type: boolean
example: true
modified_gre_tunnel:
type: object
iam_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/iam_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/iam_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_device_settings_policy:
type: object
properties:
allow_mode_switch:
$ref: '#/components/schemas/teams-devices_allow_mode_switch'
allow_updates:
$ref: '#/components/schemas/teams-devices_allow_updates'
allowed_to_leave:
$ref: '#/components/schemas/teams-devices_allowed_to_leave'
auto_connect:
$ref: '#/components/schemas/teams-devices_auto_connect'
captive_portal:
$ref: '#/components/schemas/teams-devices_captive_portal'
default:
$ref: '#/components/schemas/teams-devices_default'
description:
$ref: '#/components/schemas/teams-devices_schemas-description'
disable_auto_fallback:
$ref: '#/components/schemas/teams-devices_disable_auto_fallback'
enabled:
type: boolean
description: Whether the policy will be applied to matching devices.
example: true
exclude:
$ref: '#/components/schemas/teams-devices_exclude'
exclude_office_ips:
$ref: '#/components/schemas/teams-devices_exclude_office_ips'
fallback_domains:
$ref: '#/components/schemas/teams-devices_fallback_domains'
gateway_unique_id:
$ref: '#/components/schemas/teams-devices_gateway_unique_id'
include:
$ref: '#/components/schemas/teams-devices_include'
lan_allow_minutes:
$ref: '#/components/schemas/teams-devices_lan_allow_minutes'
lan_allow_subnet_size:
$ref: '#/components/schemas/teams-devices_lan_allow_subnet_size'
match:
$ref: '#/components/schemas/teams-devices_schemas-match'
name:
type: string
description: The name of the device settings profile.
example: Allow Developers
maxLength: 100
policy_id:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
precedence:
$ref: '#/components/schemas/teams-devices_precedence'
service_mode_v2:
$ref: '#/components/schemas/teams-devices_service_mode_v2'
support_url:
$ref: '#/components/schemas/teams-devices_support_url'
switch_locked:
$ref: '#/components/schemas/teams-devices_switch_locked'
tls-certificates-and-hostnames_schemas-updated_at:
type: string
format: date-time
description: This is the time the certificate was updated.
example: '2022-11-22T17:32:30.467938Z'
security-center_issueClass:
type: string
example: always_use_https_not_enabled
addressing_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
access_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/access_messages'
messages:
$ref: '#/components/schemas/access_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
workers_script_name:
type: string
description: Name of the script, used in URLs and route configuration.
example: this-is_my_script-01
pattern: ^[a-z0-9_][a-z0-9-_]*$
load-balancing_notification_filter:
type: object
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/load-balancing_filter_options'
pool:
$ref: '#/components/schemas/load-balancing_filter_options'
magic-transit_traceroute_response_collection:
allOf:
- $ref: '#/components/schemas/magic-transit_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/magic-transit_target_result'
access_public_key:
type: string
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
aaa_mechanism_type:
type: string
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
magic-visibility_mnm_rule_advertisable_response:
type: object
nullable: true
required:
- automatic_advertisement
properties:
automatic_advertisement:
$ref: '#/components/schemas/magic-visibility_mnm_rule_automatic_advertisement'
access_response_collection_hostnames:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_settings'
magic-transit_target_result:
type: object
properties:
colos:
type: array
items:
$ref: '#/components/schemas/magic-transit_colo_result'
target:
$ref: '#/components/schemas/magic-transit_target'
dlp_api-response-single:
allOf:
- $ref: '#/components/schemas/dlp_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
teams-devices_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_thumbnailTimestampPct:
type: number
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.
default: 0
example: 0.529241
minimum: 0
maximum: 1
load-balancing_schemas-enabled:
type: boolean
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.
default: true
example: true
secondary-dns_account_identifier:
example: 01a7362d577a6c3019a474fd6f485823
readOnly: true
tunnel_ingressRule:
type: object
description: Public hostname
required:
- hostname
- service
properties:
hostname:
type: string
description: Public hostname for this service.
example: tunnel.example.com
originRequest:
$ref: '#/components/schemas/tunnel_originRequest'
path:
type: string
description: Requests with this path route to this public hostname.
default: ''
example: subpath
service:
type: string
description: 'Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. ''http_status:404''.
'
example: https://localhost:8001
stream_audio_label:
type: string
description: A string to uniquely identify the track amongst other audio track labels for the specified video.
example: director commentary
load-balancing_references_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- properties:
result:
type: array
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:
type: object
properties:
reference_type:
type: string
enum:
- '*'
- referral
- referrer
resource_id:
type: string
resource_name:
type: string
resource_type:
type: string
workers_r2_binding:
type: object
required:
- name
- type
- bucket_name
properties:
bucket_name:
type: string
description: R2 bucket to bind to
example: my-r2-bucket
name:
$ref: '#/components/schemas/workers_binding_name'
type:
type: string
description: The class of resource that the binding provides.
enum:
- r2_bucket
example: r2_bucket
access_policies_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_policies'
workers_account-settings-response:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
default_usage_model:
readOnly: true
green_compute:
readOnly: true
magic_components-schemas-tunnel_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
interconnect:
type: object
magic-visibility_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
load-balancing_filter_options:
type: object
description: Filter options for a particular resource type (pool or origin). Use null to reset.
nullable: true
properties:
disable:
type: boolean
description: If set true, disable notifications for this type of resource (pool or origin).
default: false
healthy:
type: boolean
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
security-center_subject:
type: string
example: example.com
workers_dlq_name:
type: string
example: example-dlq
tunnel_virtual-network:
type: object
required:
- id
- name
- is_default_network
- comment
- created_at
properties:
comment:
$ref: '#/components/schemas/tunnel_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/tunnel_vnet_id'
is_default_network:
$ref: '#/components/schemas/tunnel_is_default_network'
name:
$ref: '#/components/schemas/tunnel_vnet_name'
load-balancing_allow_insecure:
type: boolean
description: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
default: false
example: true
addressing_approved:
type: string
description: Approval state of the prefix (P = pending, V = active).
example: P
secondary-dns_secret:
type: string
description: TSIG secret.
example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c
digital-experience-monitoring_api-response-collection:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/digital-experience-monitoring_result_info'
type: object
cloudforce-one_request-types:
type: array
title: Request Types
example:
- Indicators of Compromise
- Victomology
items:
type: string
description: Request Types
rum_snippet:
type: string
description: Encoded JavaScript snippet.
example: ''
vectorize_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
digital-experience-monitoring_mode:
type: string
description: The mode under which the WARP client is run
example: proxy
teams-devices_default_device_settings_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
$ref: '#/components/schemas/teams-devices_default_device_settings_policy'
access_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_groups'
iam_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
tunnel_connections:
type: array
description: The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
items:
$ref: '#/components/schemas/tunnel_schemas-connection'
turnstile_bot_fight_mode:
type: boolean
description: 'If bot_fight_mode is set to `true`, Cloudflare issues computationally
expensive challenges in response to malicious bots (ENT only).
'
example: false
digital-experience-monitoring_traceroute_details_response:
type: object
required:
- kind
- name
- host
- interval
properties:
host:
type: string
description: The host of the Traceroute synthetic application test
example: 1.1.1.1
interval:
type: string
description: The interval at which the Traceroute synthetic application test is set to run.
example: 0h5m0s
kind:
enum:
- traceroute
name:
type: string
description: The name of the Traceroute synthetic application test
example: Atlassian Sign In Page
tracerouteStats:
type: object
nullable: true
required:
- uniqueDevicesTotal
- roundTripTimeMs
- hopsCount
- packetLossPct
- availabilityPct
properties:
availabilityPct:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
hopsCount:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
packetLossPct:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
roundTripTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
uniqueDevicesTotal:
type: integer
description: Count of unique devices that have run this test in the given time period
example: 57
tracerouteStatsByColo:
type: array
items:
type: object
required:
- colo
- uniqueDevicesTotal
- roundTripTimeMs
- hopsCount
- packetLossPct
- availabilityPct
properties:
availabilityPct:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
colo:
type: string
example: DFW
hopsCount:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
packetLossPct:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time'
roundTripTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
uniqueDevicesTotal:
type: integer
description: Count of unique devices that have run this test in the given time period
example: 57
rulesets_RulesetPhase:
type: string
title: Phase
description: The phase of the ruleset.
enum:
- ddos_l4
- ddos_l7
- http_config_settings
- http_custom_errors
- http_log_custom_fields
- http_ratelimit
- http_request_cache_settings
- http_request_dynamic_redirect
- http_request_firewall_custom
- http_request_firewall_managed
- http_request_late_transform
- http_request_origin
- http_request_redirect
- http_request_sanitize
- http_request_sbfm
- http_request_select_configuration
- http_request_transform
- http_response_compression
- http_response_firewall_managed
- http_response_headers_transform
- magic_transit
- magic_transit_ids_managed
- magic_transit_managed
example: http_request_firewall_custom
teams-devices_application_input_request:
type: object
title: Application
required:
- path
- operating_system
properties:
operating_system:
type: string
description: Operating system
enum:
- windows
- linux
- mac
example: mac
path:
type: string
description: Path for the application.
example: /bin/cat
sha256:
type: string
description: SHA-256.
example: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
thumbprint:
type: string
description: Signing certificate thumbprint.
example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
turnstile_widget_list:
type: object
description: A Turnstile Widgets configuration as it appears in listings
required:
- sitekey
- created_on
- modified_on
- name
- domains
- mode
- region
- bot_fight_mode
- offlabel
- clearance_level
properties:
bot_fight_mode:
$ref: '#/components/schemas/turnstile_bot_fight_mode'
clearance_level:
$ref: '#/components/schemas/turnstile_clearance_level'
created_on:
$ref: '#/components/schemas/turnstile_created_on'
domains:
$ref: '#/components/schemas/turnstile_domains'
mode:
$ref: '#/components/schemas/turnstile_mode'
modified_on:
$ref: '#/components/schemas/turnstile_modified_on'
name:
$ref: '#/components/schemas/turnstile_name'
offlabel:
$ref: '#/components/schemas/turnstile_offlabel'
region:
$ref: '#/components/schemas/turnstile_region'
sitekey:
$ref: '#/components/schemas/turnstile_sitekey'
lists_item_comment:
type: string
description: An informative summary of the list item.
example: Private IP address
magic_nat:
type: object
properties:
static_prefix:
$ref: '#/components/schemas/magic_cidr'
custom-pages_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
stream_live_input:
type: object
description: Details about a live input.
properties:
created:
$ref: '#/components/schemas/stream_live_input_created'
deleteRecordingAfterDays:
$ref: '#/components/schemas/stream_live_input_recording_deletion'
meta:
$ref: '#/components/schemas/stream_live_input_metadata'
modified:
$ref: '#/components/schemas/stream_live_input_modified'
recording:
$ref: '#/components/schemas/stream_live_input_recording_settings'
rtmps:
$ref: '#/components/schemas/stream_input_rtmps'
rtmpsPlayback:
$ref: '#/components/schemas/stream_playback_rtmps'
srt:
$ref: '#/components/schemas/stream_input_srt'
srtPlayback:
$ref: '#/components/schemas/stream_playback_srt'
status:
$ref: '#/components/schemas/stream_live_input_status'
uid:
$ref: '#/components/schemas/stream_live_input_identifier'
webRTC:
$ref: '#/components/schemas/stream_input_webrtc'
webRTCPlayback:
$ref: '#/components/schemas/stream_playback_webrtc'
lists_num_items:
type: number
description: The number of items in the list.
example: 10
magic_gre:
type: object
description: The configuration specific to GRE interconnects.
properties:
cloudflare_endpoint:
type: string
description: The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.
example: 203.0.113.1
addressing_asn:
type: integer
description: Autonomous System Number (ASN) the prefix will be advertised under.
example: 209242
nullable: true
dlp_DatasetUploadStatus:
type: string
enum:
- empty
- uploading
- failed
- complete
bill-subs-api_frequency:
type: string
description: How often the subscription is renewed automatically.
enum:
- weekly
- monthly
- quarterly
- yearly
example: monthly
access_tag_without_app_count:
type: object
description: A tag
required:
- name
properties:
created_at:
$ref: '#/components/schemas/access_timestamp'
name:
$ref: '#/components/schemas/access_tags_components-schemas-name'
updated_at:
$ref: '#/components/schemas/access_timestamp'
magic-visibility_pcaps_error_message:
type: string
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.
workers_id:
type: string
description: Identifier for the tail.
example: 03dc9f77817b488fb26c5861ec18f791
rulesets_LogRule:
allOf:
- $ref: '#/components/schemas/rulesets_Rule'
- title: Log rule
properties:
action:
enum:
- log
action_parameters:
enum:
- {}
description:
example: Log when the IP address is not 1.1.1.1
registrar-api_locked:
type: boolean
description: Shows whether a registrar lock is in place for a domain.
example: false
tunnel_connection_id:
type: string
description: UUID of the Cloudflare Tunnel connection.
example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
readOnly: true
maxLength: 36
dlp_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
stream_live_input_identifier:
type: string
description: A unique identifier for a live input.
example: 66be4bf738797e01e1fca35a7bdecdcd
maxLength: 32
dlp_custom_entry:
type: object
title: Custom entry
description: A custom entry that matches a profile
properties:
created_at:
$ref: '#/components/schemas/dlp_timestamp'
enabled:
type: boolean
description: Whether the entry is enabled or not.
example: true
id:
$ref: '#/components/schemas/dlp_entry_id'
name:
type: string
description: The name of the entry.
example: Credit card (Visa)
pattern:
$ref: '#/components/schemas/dlp_pattern'
profile_id:
description: ID of the parent profile
updated_at:
$ref: '#/components/schemas/dlp_timestamp'
tunnel_tunnel_client_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/tunnel_tunnel_client'
teams-devices_disable_for_time:
type: object
properties:
'1':
description: Override code that is valid for 1 hour.
example: '9106681'
'3':
description: Override code that is valid for 3 hours.
example: '5356247'
'6':
description: Override code that is valid for 6 hours.
example: '9478972'
'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'
tunnel_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
dlp_DatasetCreationResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetCreation'
digital-experience-monitoring_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/digital-experience-monitoring_messages'
messages:
$ref: '#/components/schemas/digital-experience-monitoring_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
pages_stage:
type: object
description: The status of the deployment.
readOnly: true
properties:
ended_on:
type: string
format: date-time
description: When the stage ended.
example: 2021-03-09 00:58:59.045000+00:00
nullable: true
readOnly: true
name:
type: string
description: The current build stage.
example: deploy
pattern: queued|initialize|clone_repo|build|deploy
started_on:
type: string
format: date-time
description: When the stage started.
example: '2021-03-09T00:55:03.923456Z'
nullable: true
readOnly: true
status:
type: string
description: State of the current stage.
example: success
readOnly: true
pattern: success|idle|active|failure|canceled
secondary-dns_api-response-single:
allOf:
- $ref: '#/components/schemas/secondary-dns_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
access_geo:
type: object
example:
country: US
properties:
country:
type: string
custom-pages_api-response-collection:
allOf:
- $ref: '#/components/schemas/custom-pages_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/custom-pages_result_info'
type: object
addressing_kind:
type: string
description: The type of the membership.
enum:
- zone
- account
example: zone
bill-subs-api_api-response-collection:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/bill-subs-api_result_info'
type: object
magic-visibility_mnm_config_router_ip:
type: string
description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.
example: 203.0.113.1/32
dns_dns_analytics_api_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/dns_dns_analytics_api_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
cloudforce-one_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
dns-firewall_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/dns-firewall_messages'
messages:
$ref: '#/components/schemas/dns-firewall_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
magic_allow_null_cipher:
type: boolean
description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).
example: true
security-center_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/security-center_messages'
messages:
$ref: '#/components/schemas/security-center_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
calls_app_response_collection:
allOf:
- $ref: '#/components/schemas/calls_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/calls_app'
calls_created:
type: string
format: date-time
description: The date and time the item was created.
example: '2014-01-02T02:20:00Z'
magic_acls_add_single_request:
type: object
description: Bidirectional ACL policy for local network traffic within a site.
properties:
acl:
type: object
required:
- name
- lan_1
- lan_2
properties:
description:
type: string
description: Description for the ACL.
example: Allows local traffic between PIN pads and cash register.
lan_1:
$ref: '#/components/schemas/magic_lan-acl-configuration'
lan_2:
$ref: '#/components/schemas/magic_lan-acl-configuration'
name:
type: string
description: The name of the ACL.
example: PIN Pad - Cash Register
protocols:
type: array
items:
type: string
description: Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.
enum:
- tcp
- udp
- icmp
stream_upload_metadata:
type: string
description: 'Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded.
Supported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`.'
example: name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20=
digital-experience-monitoring_uniqueDevicesTotal:
type: number
description: Number of unique devices
access_session_duration:
type: string
description: 'The amount of time that tokens issued for applications 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
stream_editAudioTrack:
type: object
properties:
default:
$ref: '#/components/schemas/stream_audio_default'
label:
$ref: '#/components/schemas/stream_audio_label'
aaa_api-response-single:
allOf:
- $ref: '#/components/schemas/aaa_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
stream_video_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_videos'
- properties:
range:
type: integer
description: The total number of remaining videos based on cursor position.
example: 1000
total:
type: integer
description: The total number of videos that match the provided filters.
example: 35586
legacy-jhs_ip_configuration:
title: An IP address 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:
type: string
description: The IP address to match. This address will be compared to the IP address of incoming requests.
example: 198.51.100.4
magic_sites_add_single_request:
type: object
properties:
site:
type: object
required:
- name
properties:
connector_id:
$ref: '#/components/schemas/magic_connector-id'
description:
type: string
ha_mode:
type: boolean
description: Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.
example: true
location:
$ref: '#/components/schemas/magic_site-location'
name:
$ref: '#/components/schemas/magic_site-name'
secondary_connector_id:
$ref: '#/components/schemas/magic_secondary-connector-id'
access_response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- type: object
properties:
result:
type: array
items:
anyOf:
- $ref: '#/components/schemas/access_azureAD'
- $ref: '#/components/schemas/access_centrify'
- $ref: '#/components/schemas/access_facebook'
- $ref: '#/components/schemas/access_github'
- $ref: '#/components/schemas/access_google'
- $ref: '#/components/schemas/access_google-apps'
- $ref: '#/components/schemas/access_linkedin'
- $ref: '#/components/schemas/access_oidc'
- $ref: '#/components/schemas/access_okta'
- $ref: '#/components/schemas/access_onelogin'
- $ref: '#/components/schemas/access_pingone'
- $ref: '#/components/schemas/access_saml'
- $ref: '#/components/schemas/access_yandex'
type: object
custom-pages_api-response-single:
allOf:
- $ref: '#/components/schemas/custom-pages_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
nullable: true
type: object
logpush_get_ownership_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
filename:
type: string
example: logs/challenge-filename.txt
message:
type: string
example: ''
valid:
type: boolean
example: true
magic_tunnel_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
gre_tunnel:
type: object
magic-visibility_mnm_rule_duration:
type: string
description: The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values ["1m","5m","10m","15m","20m","30m","45m","60m"]. The format is AhBmCsDmsEusFns where A, B, C, D, E and F durations are optional; however at least one unit must be provided.
default: 1m
example: 300s
zero-trust-gateway_uuid:
type: string
description: API Resource UUID tag.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
maxLength: 36
stream_signed_token_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
properties:
token:
type: string
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
magic-visibility_pcaps_byte_limit:
type: number
description: The maximum number of bytes to capture. This field only applies to `full` packet captures.
example: 500000
minimum: 1
maximum: 1000000000
dns_dns_analytics_api_query:
type: object
required:
- dimensions
- metrics
- since
- until
- limit
properties:
dimensions:
type: array
description: Array of dimension names.
example:
- responseCode
- queryName
items:
type: string
description: Dimension name.
example: responseCode
filters:
$ref: '#/components/schemas/dns_dns_analytics_api_filters'
limit:
$ref: '#/components/schemas/dns_dns_analytics_api_limit'
metrics:
type: array
description: Array of metric names.
example:
- queryCount
- responseTimeAvg
items:
type: string
description: Metric name.
example: queries
since:
$ref: '#/components/schemas/dns_dns_analytics_api_since'
sort:
type: array
description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
example:
- +responseCode
- -queryName
items:
type: string
description: Dimension name (may be prefixed by - (descending) or + (ascending).
example: +responseCode
until:
$ref: '#/components/schemas/dns_dns_analytics_api_until'
magic-visibility_pcaps_single_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-single'
- properties:
result:
anyOf:
- $ref: '#/components/schemas/magic-visibility_pcaps_response_simple'
- $ref: '#/components/schemas/magic-visibility_pcaps_response_full'
intel_single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_domain'
tunnel_config_version:
type: integer
description: The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.
access_organizations:
type: object
properties:
allow_authenticate_via_warp:
$ref: '#/components/schemas/access_allow_authenticate_via_warp'
auth_domain:
$ref: '#/components/schemas/access_auth_domain'
auto_redirect_to_identity:
$ref: '#/components/schemas/access_auto_redirect_to_identity'
created_at:
$ref: '#/components/schemas/access_timestamp'
custom_pages:
$ref: '#/components/schemas/access_custom_pages'
is_ui_read_only:
$ref: '#/components/schemas/access_is_ui_read_only'
login_design:
$ref: '#/components/schemas/access_login_design'
name:
$ref: '#/components/schemas/access_name'
session_duration:
$ref: '#/components/schemas/access_session_duration'
ui_read_only_toggle_reason:
$ref: '#/components/schemas/access_ui_read_only_toggle_reason'
updated_at:
$ref: '#/components/schemas/access_timestamp'
user_seat_expiration_inactive_time:
$ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
warp_auth_session_duration:
$ref: '#/components/schemas/access_warp_auth_session_duration'
cloudforce-one_time:
type: string
format: date-time
example: '2022-04-01T05:20:00Z'
magic_psk:
type: string
description: A randomly generated or provided string for use in the IPsec tunnel.
example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy
stream_downloads_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
tunnel_comment:
type: string
description: Optional remark describing the route.
example: Example comment for this route.
aaa_webhooks_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_webhooks'
magic-visibility_mnm_rule_bandwidth_threshold:
type: number
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
stream_live_input_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
$ref: '#/components/schemas/stream_live_input'
magic-transit_asn:
type: string
description: AS number associated with the node object.
cloudforce-one_request-list-item:
type: object
title: Request List Item
required:
- id
- created
- updated
- priority
- request
- summary
- tlp
properties:
completed:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Request completion time
- example: '2024-01-01T00:00:00Z'
created:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Request creation time
- example: '2022-04-01T00:00:00Z'
id:
$ref: '#/components/schemas/cloudforce-one_uuid'
message_tokens:
type: integer
description: Tokens for the request messages
example: 16
priority:
$ref: '#/components/schemas/cloudforce-one_priority'
readable_id:
$ref: '#/components/schemas/cloudforce-one_request-readable-id'
request:
$ref: '#/components/schemas/cloudforce-one_request-type'
status:
$ref: '#/components/schemas/cloudforce-one_request-status'
summary:
$ref: '#/components/schemas/cloudforce-one_request-summary'
tlp:
$ref: '#/components/schemas/cloudforce-one_tlp'
tokens:
type: integer
description: Tokens for the request
updated:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Request last updated time
- example: '2022-04-01T00:00:00Z'
request-tracer_identifier:
type: string
description: Identifier
example: 023e105f4ecef8ad9ca31a8372d0c353
readOnly: true
maxLength: 32
magic_acl_deleted_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
deleted:
type: boolean
example: true
deleted_acl:
$ref: '#/components/schemas/magic_acl'
workers-kv_key_name:
type: string
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
teams-devices_default_device_settings_policy:
type: object
properties:
allow_mode_switch:
$ref: '#/components/schemas/teams-devices_allow_mode_switch'
allow_updates:
$ref: '#/components/schemas/teams-devices_allow_updates'
allowed_to_leave:
$ref: '#/components/schemas/teams-devices_allowed_to_leave'
auto_connect:
$ref: '#/components/schemas/teams-devices_auto_connect'
captive_portal:
$ref: '#/components/schemas/teams-devices_captive_portal'
default:
type: boolean
description: Whether the policy will be applied to matching devices.
example: true
disable_auto_fallback:
$ref: '#/components/schemas/teams-devices_disable_auto_fallback'
enabled:
type: boolean
description: Whether the policy will be applied to matching devices.
example: true
exclude:
$ref: '#/components/schemas/teams-devices_exclude'
exclude_office_ips:
$ref: '#/components/schemas/teams-devices_exclude_office_ips'
fallback_domains:
$ref: '#/components/schemas/teams-devices_fallback_domains'
gateway_unique_id:
$ref: '#/components/schemas/teams-devices_gateway_unique_id'
include:
$ref: '#/components/schemas/teams-devices_include'
service_mode_v2:
$ref: '#/components/schemas/teams-devices_service_mode_v2'
support_url:
$ref: '#/components/schemas/teams-devices_support_url'
switch_locked:
$ref: '#/components/schemas/teams-devices_switch_locked'
dlp_shared_entry_update_integration:
type: object
title: Update integration entry
description: Properties of an integration entry in a custom profile
properties:
enabled:
type: boolean
description: Whether the entry is enabled or not.
entry_id:
$ref: '#/components/schemas/dlp_entry_id'
workers_logpush:
type: boolean
description: Whether Logpush is turned on for the Worker.
example: false
hyperdrive_hyperdrive-caching:
type: object
properties:
disabled:
type: boolean
description: 'When set to true, disables the caching of SQL responses. (Default: false)'
example: false
max_age:
type: integer
description: 'When present, specifies max duration for which items should persist in the cache. (Default: 60)'
example: 60
stale_while_revalidate:
type: integer
description: 'When present, indicates the number of seconds cache may serve the response after it becomes stale. (Default: 15)'
example: 15
stream_output_url:
type: string
description: The URL an output uses to restream.
example: rtmp://a.rtmp.youtube.com/live2
magic_site_single_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
site:
$ref: '#/components/schemas/magic_site'
access_ray_id:
type: string
description: The unique identifier for the request to Cloudflare.
example: 187d944c61940c77
maxLength: 16
access_facebook:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
$ref: '#/components/schemas/access_generic-oauth-config'
type: object
title: Facebook
zero-trust-gateway_single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_lists'
zero-trust-gateway_subdomain:
type: string
description: The DNS over HTTPS domain to send DNS requests to. This field is auto-generated by Gateway.
example: oli3n9zkz5
images_image_keys_response:
type: object
properties:
keys:
type: array
items:
$ref: '#/components/schemas/images_image_keys'
pages_domain-response-single:
allOf:
- $ref: '#/components/schemas/pages_api-response-single'
- properties:
result:
type: object
request-tracer_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/request-tracer_messages'
messages:
$ref: '#/components/schemas/request-tracer_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
stream_end_time_seconds:
type: integer
description: Specifies the end time for the video clip in seconds.
magic_schemas-tunnels_collection_response:
allOf:
- $ref: '#/components/schemas/magic_api-response-single'
- properties:
result:
properties:
ipsec_tunnels:
type: array
items:
$ref: '#/components/schemas/magic_ipsec-tunnel'
images_signing_key_identifier:
example: someKey
maxLength: 20
pattern: ^[a-zA-Z0-9]$
hyperdrive_patch-hyperdrive-config:
allOf:
- $ref: '#/components/schemas/hyperdrive_hyperdrive'
type: object
properties:
origin:
$ref: '#/components/schemas/hyperdrive_hyperdrive-origin-with-password'
intel_categories_with_super_category_ids_example_empty:
type: array
example: []
items:
$ref: '#/components/schemas/intel_category_with_super_category_id'
email_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
aaa_components-schemas-description:
type: string
description: Description of the notification policy (if present).
example: Universal Certificate validation status, issuance, renewal, and expiration notices
stream_height:
type: integer
description: The height of the image in pixels.
access_service-tokens_components-schemas-name:
type: string
description: The name of the service token.
example: CI/CD token
intel_url_id:
type: integer
description: Submission ID(s) to filter submission results by.
stream_jwk:
type: string
description: The signing key in JWK format.
example: eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=
tunnel_originRequest:
type: object
description: Configuration parameters of connection between cloudflared and origin server.
properties:
access:
type: object
description: For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.
required:
- audTag
- teamName
properties:
audTag:
type: array
description: Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.
items:
type: string
required:
type: boolean
description: Deny traffic that has not fulfilled Access authorization.
default: false
teamName:
type: string
default: Your Zero Trust authentication domain.
caPool:
type: string
description: Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.
default: ''
connectTimeout:
type: integer
description: Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
default: 10
disableChunkedEncoding:
type: boolean
description: Disables chunked transfer encoding. Useful if you are running a WSGI server.
http2Origin:
type: boolean
description: Attempt to connect to origin using HTTP2. Origin must be configured as https.
httpHostHeader:
type: string
description: Sets the HTTP Host header on requests sent to the local service.
keepAliveConnections:
type: integer
description: Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
default: 100
keepAliveTimeout:
type: integer
description: Timeout after which an idle keepalive connection can be discarded.
default: 90
noHappyEyeballs:
type: boolean
description: Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
default: false
noTLSVerify:
type: boolean
description: Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
default: false
originServerName:
type: string
description: Hostname that cloudflared should expect from your origin server certificate.
default: ''
proxyType:
type: string
description: 'cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.
'
default: ''
tcpKeepAlive:
type: integer
description: The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.
default: 30
tlsTimeout:
type: integer
description: Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.
default: 10
security-center_page:
type: integer
description: Current page within paginated list of results
example: 1
load-balancing_api-response-single:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
addressing_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_address-maps'
access_allowed_headers:
type: array
description: Allowed HTTP request headers.
items: {}
stream_live_input_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: object
properties:
liveInputs:
type: array
items:
$ref: '#/components/schemas/stream_live_input_object_without_url'
range:
type: integer
description: The total number of remaining live inputs based on cursor position.
example: 1000
total:
type: integer
description: The total number of live inputs that match the provided filters.
example: 35586
addressing_bgp_prefix_update_advertisement:
type: object
properties:
on_demand:
type: object
properties:
advertised:
type: boolean
tunnel_management-resources:
type: string
description: Management resources the token will have access to.
enum:
- logs
example: logs
access_key_rotation_interval_days:
type: number
description: The number of days between key rotations.
example: 30
minimum: 21
maximum: 365
images_images_stats_response:
allOf:
- $ref: '#/components/schemas/images_api-response-single'
- properties:
result:
$ref: '#/components/schemas/images_images_stats'
stream_accessRules:
type: object
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:
type: string
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
country:
type: array
description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.
items:
type: string
ip:
type: array
description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests.
items:
type: string
type:
type: string
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
dlp_update_settings:
type: object
title: Settings
description: Payload log settings
required:
- public_key
properties:
public_key:
type: string
description: The public key to use when encrypting extracted payloads, as a base64 string
example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=
nullable: true
magic_prefix:
type: string
description: IP Prefix in Classless Inter-Domain Routing format.
example: 192.0.2.0/24
stream_playback_srt_url:
type: string
description: The URL used to play live video over SRT.
example: rtmps://live.cloudflare.com:443/live/
magic_lan:
type: object
properties:
description:
type: string
ha_link:
type: boolean
description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
id:
$ref: '#/components/schemas/magic_identifier'
nat:
$ref: '#/components/schemas/magic_nat'
physport:
$ref: '#/components/schemas/magic_port'
routed_subnets:
type: array
items:
$ref: '#/components/schemas/magic_routed_subnet'
site_id:
$ref: '#/components/schemas/magic_identifier'
static_addressing:
$ref: '#/components/schemas/magic_lan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
access_schemas-app_launcher_visible:
type: boolean
description: Displays the application in the App Launcher.
example: true
security-center_perPage:
type: integer
description: Number of results per page of results
example: 25
minimum: 1
maximum: 1000
tunnel_tunnel_client:
type: object
description: A client (typically cloudflared) that maintains connections to a Cloudflare data center.
properties:
arch:
$ref: '#/components/schemas/tunnel_arch'
config_version:
$ref: '#/components/schemas/tunnel_config_version'
conns:
$ref: '#/components/schemas/tunnel_connections'
features:
$ref: '#/components/schemas/tunnel_features'
id:
$ref: '#/components/schemas/tunnel_connection_id'
run_at:
$ref: '#/components/schemas/tunnel_run_at'
version:
$ref: '#/components/schemas/tunnel_version'
stream_playback_rtmps:
type: object
description: Details for playback from an live input using RTMPS.
properties:
streamKey:
$ref: '#/components/schemas/stream_playback_rtmps_stream_key'
url:
$ref: '#/components/schemas/stream_playback_rtmps_url'
magic-transit_colo:
type: object
properties:
city:
$ref: '#/components/schemas/magic-transit_colo_city'
name:
$ref: '#/components/schemas/magic-transit_colo_name'
bill-subs-api_state:
type: string
description: The state that the subscription is in.
enum:
- Trial
- Provisioned
- Paid
- AwaitingPayment
- Cancelled
- Failed
- Expired
example: Paid
readOnly: true
teams-devices_ip:
type: string
description: IPv4 or IPv6 address.
example: 1.1.1.1
workers_cron-trigger-response-collection:
allOf:
- $ref: '#/components/schemas/workers_api-response-common'
- properties:
result:
type: object
properties:
schedules:
type: array
items:
properties:
created_on:
readOnly: true
cron:
readOnly: true
modified_on:
readOnly: true
load-balancing_latitude:
type: number
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.
lists_items:
type: array
items:
$ref: '#/components/schemas/lists_item'
access_apps:
anyOf:
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_self_hosted_props'
type: object
title: Self Hosted Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_saas_props'
type: object
title: SaaS Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_ssh_props'
type: object
title: Browser SSH Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_vnc_props'
type: object
title: Browser VNC Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_app_launcher_props'
type: object
title: App Launcher Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_warp_props'
type: object
title: Device Enrollment Permissions Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_biso_props'
type: object
title: Browser Isolation Permissions Application
- allOf:
- $ref: '#/components/schemas/access_basic_app_response_props'
- $ref: '#/components/schemas/access_bookmark_props'
type: object
title: Bookmark application
intel_api-response-collection:
allOf:
- $ref: '#/components/schemas/intel_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/intel_result_info'
type: object
logpush_name:
type: string
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
nullable: true
maxLength: 512
pattern: ^[a-zA-Z0-9\-\.]*$
access_oidc:
allOf:
- $ref: '#/components/schemas/access_identity-provider'
- type: object
properties:
config:
allOf:
- $ref: '#/components/schemas/access_generic-oauth-config'
- $ref: '#/components/schemas/access_custom-claims-support'
- type: object
properties:
auth_url:
type: string
description: The authorization_endpoint URL of your IdP
example: https://accounts.google.com/o/oauth2/auth
certs_url:
type: string
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
scopes:
type: array
description: OAuth scopes
example:
- openid
- email
- profile
items:
type: string
token_url:
type: string
description: The token_endpoint URL of your IdP
example: https://accounts.google.com/o/oauth2/token
type: object
title: Generic OAuth
legacy-jhs_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
access_connection:
type: string
description: The IdP used to authenticate.
example: saml
logpush_enabled:
type: boolean
description: Flag that indicates if the job is enabled.
example: false
aaa_integration-token:
type: string
description: The token integration key
example: 8c71e667571b4f61b94d9e4b12158038
readOnly: true
maxLength: 32
legacy-jhs_asn_configuration:
title: An 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:
type: string
description: The AS number to match.
example: AS12345
magic-transit_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/magic-transit_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/magic-transit_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
rum_rules:
type: array
description: A list of rules.
items:
$ref: '#/components/schemas/rum_rule'
intel_update_feed_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_update_feed'
magic-visibility_pcaps_ownership_single_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-common'
- properties:
result:
$ref: '#/components/schemas/magic-visibility_pcaps_ownership_response'
digital-experience-monitoring_http_details_response:
type: object
properties:
host:
type: string
description: The url of the HTTP synthetic application test
example: http://example.com
httpStats:
type: object
nullable: true
required:
- uniqueDevicesTotal
- resourceFetchTimeMs
- serverResponseTimeMs
- dnsResponseTimeMs
- httpStatusCode
properties:
dnsResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
httpStatusCode:
type: array
items:
type: object
required:
- timestamp
- status200
- status300
- status400
- status500
properties:
status200:
type: integer
status300:
type: integer
status400:
type: integer
status500:
type: integer
timestamp:
type: string
example: 2023-07-16 15:00:00+00:00
resourceFetchTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
serverResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
uniqueDevicesTotal:
type: integer
description: Count of unique devices that have run this test in the given time period
example: 57
httpStatsByColo:
type: array
items:
type: object
required:
- colo
- uniqueDevicesTotal
- resourceFetchTimeMs
- serverResponseTimeMs
- dnsResponseTimeMs
- httpStatusCode
properties:
colo:
type: string
example: DFW
dnsResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
httpStatusCode:
type: array
items:
type: object
required:
- timestamp
- status200
- status300
- status400
- status500
properties:
status200:
type: integer
status300:
type: integer
status400:
type: integer
status500:
type: integer
timestamp:
type: string
example: 2023-07-16 15:00:00+00:00
resourceFetchTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
serverResponseTimeMs:
$ref: '#/components/schemas/digital-experience-monitoring_test_stat_over_time'
uniqueDevicesTotal:
type: integer
description: Count of unique devices that have run this test in the given time period
example: 57
interval:
type: string
description: The interval at which the HTTP synthetic application test is set to run.
example: 0h5m0s
kind:
enum:
- http
method:
type: string
description: The HTTP method to use when running the test
example: GET
name:
type: string
description: The name of the HTTP synthetic application test
example: Atlassian Sign In Page
magic-transit_labels:
type: array
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
magic-visibility_mnm_rule_advertisement_single_response:
allOf:
- $ref: '#/components/schemas/magic-visibility_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/magic-visibility_mnm_rule_advertisable_response'
dns-custom-nameservers_ns_set:
type: number
description: The number of the set that this name server belongs to.
default: 1
example: 1
minimum: 1
maximum: 5
iam_code:
type: string
description: The unique activation code for the account membership.
example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0
readOnly: true
maxLength: 64
digital-experience-monitoring_api-response-single:
allOf:
- $ref: '#/components/schemas/digital-experience-monitoring_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
images_image_variants:
type: array
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
readOnly: true
items:
anyOf:
- $ref: '#/components/schemas/images_image_thumbnail_url'
- $ref: '#/components/schemas/images_image_hero_url'
- $ref: '#/components/schemas/images_image_original_url'
bill-subs-api_api-response-single:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
access_external_evaluation_rule:
type: object
title: External Evaluation
description: Create Allow or Block policies which evaluate the user based on custom criteria.
required:
- external_evaluation
properties:
external_evaluation:
type: object
required:
- evaluate_url
- keys_url
properties:
evaluate_url:
type: string
description: The API endpoint containing your business logic.
example: https://eval.example.com
keys_url:
type: string
description: The API endpoint containing the key that Access uses to verify that the response came from your API.
example: https://eval.example.com/keys
stream_opacity:
type: number
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.
default: 1
example: 0.75
minimum: 0
maximum: 1
stream_watermark_at_upload:
type: object
properties:
uid:
type: string
description: The unique identifier for the watermark profile.
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
access_result_info:
type: object
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
access_schemas-session_duration:
type: string
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.'
default: 24h
example: 24h
cloudforce-one_request-message-item:
type: object
title: Request Message Item
required:
- id
- updated
- content
- author
- is_follow_on_request
properties:
author:
type: string
description: Author of message
example: user@domain.com
content:
$ref: '#/components/schemas/cloudforce-one_message-content'
created:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Message creation time
- example: '2022-01-01T00:00:00Z'
id:
type: integer
description: Message ID
is_follow_on_request:
type: boolean
description: Message is a follow-on request
updated:
allOf:
- $ref: '#/components/schemas/cloudforce-one_time'
- description: Message last updated time
- example: '2022-01-01T00:00:00Z'
access_identity-provider:
type: object
required:
- name
- type
- config
properties:
config:
type: object
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/).
id:
$ref: '#/components/schemas/access_uuid'
name:
$ref: '#/components/schemas/access_schemas-name'
scim_config:
type: object
description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
properties:
enabled:
type: boolean
description: A flag to enable or disable SCIM for the identity provider.
group_member_deprovision:
type: boolean
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.
seat_deprovision:
type: boolean
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.
secret:
type: string
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.
user_deprovision:
type: boolean
description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.
type:
type: string
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/).
enum:
- onetimepin
- azureAD
- saml
- centrify
- facebook
- github
- google-apps
- google
- linkedin
- oidc
- okta
- onelogin
- pingone
- yandex
example: onetimepin
intel_indicator_feed_metadata_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_indicator_feed_metadata'
vectorize_index-dimension-configuration:
type: object
required:
- dimensions
- metric
properties:
dimensions:
$ref: '#/components/schemas/vectorize_index-dimensions'
metric:
$ref: '#/components/schemas/vectorize_index-metric'
secondary-dns_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/secondary-dns_messages'
messages:
$ref: '#/components/schemas/secondary-dns_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
images_image_variants_response:
type: object
properties:
variants:
$ref: '#/components/schemas/images_image_variant_public_request'
load-balancing_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/load-balancing_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/load-balancing_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
addressing_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-delegations'
rum_ruleset:
type: object
properties:
enabled:
type: boolean
description: Whether the ruleset is enabled.
example: true
id:
$ref: '#/components/schemas/rum_ruleset_identifier'
zone_name:
type: string
example: example.com
zone_tag:
$ref: '#/components/schemas/rum_zone_tag'
rum_ruleset_identifier:
type: string
description: The Web Analytics ruleset identifier.
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
zero-trust-gateway_gateway_tag:
type: string
description: Gateway internal ID.
example: f174e90afafe4643bbbc4a0ed4fc8415
maxLength: 32
tunnel_tunnel_id:
type: string
description: UUID of the tunnel.
example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
magic_colo_name:
type: string
description: Scope colo name.
example: den01
teams-devices_device-dex-test-schemas-name:
type: string
description: The name of the DEX test. Must be unique.
example: HTTP dash health check
stream_videoClipStandard:
type: object
required:
- clippedFromVideoUID
- startTimeSeconds
- endTimeSeconds
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
clippedFromVideoUID:
$ref: '#/components/schemas/stream_clipped_from_video_uid'
creator:
$ref: '#/components/schemas/stream_creator'
endTimeSeconds:
$ref: '#/components/schemas/stream_end_time_seconds'
maxDurationSeconds:
$ref: '#/components/schemas/stream_maxDurationSeconds'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
startTimeSeconds:
$ref: '#/components/schemas/stream_start_time_seconds'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
watermark:
$ref: '#/components/schemas/stream_watermarkAtUpload'
teams-devices_schemas-type:
type: string
description: The type of device posture integration.
enum:
- workspace_one
- crowdstrike_s2s
- uptycs
- intune
- kolide
- tanium
- sentinelone_s2s
example: workspace_one
access_include:
type: array
description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
items:
$ref: '#/components/schemas/access_rule'
workers-kv_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
magic_mtu:
type: integer
description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.
default: 1476
stream_maxDurationSeconds:
type: integer
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.
minimum: 1
maximum: 21600
iam_single_role_response:
allOf:
- $ref: '#/components/schemas/iam_api-response-single'
- type: object
properties:
result:
type: object
access_uuid:
type: string
description: UUID
example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
readOnly: true
maxLength: 36
teams-devices_file_input_request:
type: object
title: File Check
required:
- path
- operating_system
properties:
exists:
type: boolean
description: Whether or not file exists
example: true
operating_system:
type: string
description: Operating system
enum:
- windows
- linux
- mac
example: mac
path:
type: string
description: File path.
example: /bin/cat
sha256:
type: string
description: SHA-256.
example: https://api.us-2.crowdstrike.com
thumbprint:
type: string
description: Signing certificate thumbprint.
example: 0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e
workers_tail_consumers_script:
type: object
description: A reference to a script that will consume logs from the attached Worker.
required:
- service
properties:
environment:
type: string
description: Optional environment if the Worker utilizes one.
example: production
namespace:
type: string
description: Optional dispatch namespace the script belongs to.
example: my-namespace
service:
type: string
description: Name of Worker that is to be the consumer.
example: my-log-consumer
intel_schemas-response:
allOf:
- $ref: '#/components/schemas/intel_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/intel_schemas-ip'
tunnel_tunnel_type:
type: string
description: The type of tunnel.
enum:
- cfd_tunnel
- warp_connector
- ip_sec
- gre
- cni
example: cfd_tunnel
logcontrol_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/logcontrol_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/logcontrol_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
teams-devices_kolide_input_request:
type: object
title: Kolide S2S Input
required:
- connection_id
- countOperator
- issue_count
properties:
connection_id:
type: string
description: Posture Integration ID.
example: bc7cbfbb-600a-42e4-8a23-45b5e85f804f
countOperator:
type: string
description: Count Operator
enum:
- <
- <=
- '>'
- '>='
- ==
example: '>'
issue_count:
type: string
description: The Number of Issues.
example: 1
stream_label:
type: string
description: The language label displayed in the native language to users.
example: Türkçe
aaa_alert_type:
type: string
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.
enum:
- access_custom_certificate_expiration_type
- advanced_ddos_attack_l4_alert
- advanced_ddos_attack_l7_alert
- advanced_http_alert_error
- bgp_hijack_notification
- billing_usage_alert
- block_notification_block_removed
- block_notification_new_block
- block_notification_review_rejected
- brand_protection_alert
- brand_protection_digest
- clickhouse_alert_fw_anomaly
- clickhouse_alert_fw_ent_anomaly
- custom_ssl_certificate_event_type
- dedicated_ssl_certificate_event_type
- dos_attack_l4
- dos_attack_l7
- expiring_service_token_alert
- failing_logpush_job_disabled_alert
- fbm_auto_advertisement
- fbm_dosd_attack
- fbm_volumetric_attack
- health_check_status_notification
- hostname_aop_custom_certificate_expiration_type
- http_alert_edge_error
- http_alert_origin_error
- incident_alert
- load_balancing_health_alert
- load_balancing_pool_enablement_alert
- logo_match_alert
- magic_tunnel_health_check_event
- maintenance_event_notification
- mtls_certificate_store_certificate_expiration_type
- pages_event_alert
- radar_notification
- real_origin_monitoring
- scriptmonitor_alert_new_code_change_detections
- scriptmonitor_alert_new_hosts
- scriptmonitor_alert_new_malicious_hosts
- scriptmonitor_alert_new_malicious_scripts
- scriptmonitor_alert_new_malicious_url
- scriptmonitor_alert_new_max_length_resource_url
- scriptmonitor_alert_new_resources
- secondary_dns_all_primaries_failing
- secondary_dns_primaries_failing
- secondary_dns_zone_successfully_updated
- secondary_dns_zone_validation_warning
- sentinel_alert
- stream_live_notifications
- traffic_anomalies_alert
- tunnel_health_event
- tunnel_update_event
- universal_ssl_event_type
- web_analytics_metrics_update
- zone_aop_custom_certificate_expiration_type
example: universal_ssl_event_type
stream_playback_rtmps_url:
type: string
description: The URL used to play live video over RTMPS.
example: rtmps://live.cloudflare.com:443/live/
turnstile_result_info:
type: object
required:
- page
- per_page
- count
- total_count
properties:
count:
type: number
description: Total number of results for the requested service
example: 1
page:
type: number
description: Current page within paginated list of results
example: 1
per_page:
type: number
description: Number of results per page of results
example: 20
total_count:
type: number
description: Total results available without any search parameters
example: 2000
tunnel_cf_account_id:
type: string
description: Cloudflare account ID
example: 699d98642c564d2e855e9661899b7252
maxLength: 32
legacy-jhs_api-response-common-failure:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
allOf:
- $ref: '#/components/schemas/legacy-jhs_messages'
example:
- code: 7003
message: No route for the URI
minLength: 1
messages:
allOf:
- $ref: '#/components/schemas/legacy-jhs_messages'
example: []
result:
type: object
enum:
- null
nullable: true
success:
type: boolean
description: Whether the API call was successful
enum:
- false
example: false
rulesets_Rule:
type: object
title: Rule
required:
- version
- last_updated
properties:
action:
$ref: '#/components/schemas/rulesets_RuleAction'
action_parameters:
type: object
title: Action parameters
description: The parameters configuring the rule's action.
categories:
type: array
title: Categories
description: The categories of the rule.
example:
- directory-traversal
- header
uniqueItems: true
readOnly: true
minItems: 1
items:
$ref: '#/components/schemas/rulesets_RuleCategory'
description:
type: string
title: Description
description: An informative description of the rule.
default: ''
enabled:
allOf:
- $ref: '#/components/schemas/rulesets_RuleEnabled'
- default: true
expression:
type: string
title: Expression
description: The expression defining which traffic will match the rule.
example: ip.src ne 1.1.1.1
minLength: 1
id:
$ref: '#/components/schemas/rulesets_RuleId'
last_updated:
type: string
title: Last updated
format: date-time
description: The timestamp of when the rule was last modified.
example: '2000-01-01T00:00:00.000000Z'
readOnly: true
logging:
type: object
title: Logging
description: An object configuring the rule's logging behavior.
required:
- enabled
properties:
enabled:
type: boolean
title: Enabled
description: Whether to generate a log when the rule matches.
example: true
ref:
type: string
title: Ref
description: The reference of the rule (the rule ID by default).
example: my_ref
minLength: 1
version:
type: string
title: Version
description: The version of the rule.
example: '1'
readOnly: true
pattern: ^[0-9]+$
dns_dns_analytics_api_filters:
type: string
description: Segmentation filter in 'attribute operator value' format.
example: responseCode==NOERROR,queryType==A
turnstile_mode:
type: string
description: Widget Mode
enum:
- non-interactive
- invisible
- managed
example: invisible
stream_search:
type: string
description: Searches over the `name` key in the `meta` field. This field can be set with or after the upload request.
example: puppy.mp4
addressing_schemas-single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-delegations'
iam_membership_components-schemas-identifier:
type: string
description: Membership identifier tag.
example: 4536bcfad5faccb111b47003c79917fa
readOnly: true
maxLength: 32
digital-experience-monitoring_timestamp:
type: string
description: Timestamp in ISO format
example: '2023-10-11T00:00:00Z'
workers_dispatch_namespace_name:
type: string
description: Name of the Workers for Platforms dispatch namespace.
example: my-dispatch-namespace
pattern: ^.+$
teams-devices_schemas-config_request:
oneOf:
- $ref: '#/components/schemas/teams-devices_tls_config_request'
type: object
description: The configuration object containing information for the WARP client to detect the managed network.
example:
sha256: b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
tls_sockaddr: foo.bar:1234
magic_lans_add_single_request:
type: object
properties:
lan:
type: object
required:
- physport
- vlan_tag
properties:
description:
type: string
ha_link:
type: boolean
description: mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.
nat:
$ref: '#/components/schemas/magic_nat'
physport:
$ref: '#/components/schemas/magic_port'
routed_subnets:
type: array
items:
$ref: '#/components/schemas/magic_routed_subnet'
static_addressing:
$ref: '#/components/schemas/magic_lan_static_addressing'
vlan_tag:
$ref: '#/components/schemas/magic_vlan_tag'
magic-transit_max_rtt_ms:
type: number
description: Maximum RTT in ms.
iam_schemas-role:
type: object
required:
- id
- name
- description
- permissions
properties:
description:
$ref: '#/components/schemas/iam_description'
id:
$ref: '#/components/schemas/iam_role_components-schemas-identifier'
name:
$ref: '#/components/schemas/iam_components-schemas-name'
permissions:
$ref: '#/components/schemas/iam_schemas-permissions'
workers_cursor:
type: string
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
cloudforce-one_request-content:
type: string
description: Request content
example: What regions were most effected by the recent DoS?
iam_grants:
type: object
example:
read: true
write: false
properties:
read:
type: boolean
example: true
write:
type: boolean
example: true
load-balancing_minimum_origins:
type: integer
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.
default: 1
zero-trust-gateway_messages:
type: array
example: []
items:
type: object
uniqueItems: true
required:
- code
- message
properties:
code:
type: integer
minimum: 1000
message:
type: string
images_image:
type: object
properties:
filename:
$ref: '#/components/schemas/images_image_filename'
id:
$ref: '#/components/schemas/images_image_identifier'
meta:
$ref: '#/components/schemas/images_image_metadata'
requireSignedURLs:
$ref: '#/components/schemas/images_image_requireSignedURLs'
uploaded:
$ref: '#/components/schemas/images_image_uploaded'
variants:
$ref: '#/components/schemas/images_image_variants'
rulesets_SkipRule:
allOf:
- $ref: '#/components/schemas/rulesets_Rule'
- title: Skip rule
properties:
action:
enum:
- skip
action_parameters:
example:
ruleset: current
properties:
phases:
type: array
title: Phases
description: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
uniqueItems: true
minItems: 1
items:
allOf:
- $ref: '#/components/schemas/rulesets_RulesetPhase'
- description: A phase to skip the execution of.
products:
type: array
title: Products
description: A list of legacy security products to skip the execution of.
uniqueItems: true
minItems: 1
items:
type: string
title: Product
description: The name of a legacy security product to skip the execution of.
enum:
- bic
- hot
- rateLimit
- securityLevel
- uaBlock
- waf
- zoneLockdown
rules:
type: object
title: Rules
description: A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
example:
4814384a9e5d4991b9815dcfc25d2f1f:
- 8ac8bc2a661e475d940980f9317f28e1
minProperties: 1
ruleset:
type: string
title: Ruleset
description: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options.
enum:
- current
rulesets:
type: array
title: Rulesets
description: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
uniqueItems: true
minItems: 1
items:
allOf:
- $ref: '#/components/schemas/rulesets_RulesetId'
- title: Ruleset
description: The ID of a ruleset to skip the execution of.
example: 4814384a9e5d4991b9815dcfc25d2f1f
minProperties: 1
description:
example: Skip the current ruleset when the IP address is not 1.1.1.1
teams-devices_unrevoke_devices_request:
type: array
description: A list of device ids to unrevoke.
maxLength: 200
items:
$ref: '#/components/schemas/teams-devices_schemas-uuid'
responses:
workers_200:
description: Upload Worker Module response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/workers_script-response-single'
- example:
errors: []
messages: []
result:
created_on: '2022-05-05T05:15:11.602148Z'
etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
handlers:
- fetch
id: this-is_my_script-01
logpush: false
modified_on: '2022-05-20T19:02:56.446492Z'
placement_mode: smart
tail_consumers:
- environment: production
service: my-log-consumer
usage_model: bundled
success: true
workers_4XX:
description: Upload Worker Module response failure
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
logpush: false
modified_on: '2022-05-20T19:02:56.446492Z'
tail_consumers:
- environment: production
service: my-log-consumer
usage_model: bundled
success: true
- $ref: '#/components/schemas/workers_api-response-common-failure'
requestBodies:
workers_script_upload:
required: true
content:
application/javascript:
schema:
type: string
description: Raw javascript content comprising a Worker. Must be in service worker syntax.
example: addEventListener('fetch', (event) => event.respondWith(new Response('OK')))
multipart/form-data:
schema:
oneOf:
- type: object
properties:
:
type: array
description: A module comprising a Worker script, often a javascript file. Multiple modules may be provided as separate named parts, but at least one module must be present and referenced in the metadata as `main_module` or `body_part` by part name.
items:
type: string
format: binary
metadata:
type: object
description: JSON encoded metadata about the uploaded parts and Worker configuration.
properties:
bindings:
type: array
description: List of bindings available to the worker.
example:
- name: MY_ENV_VAR
text: my_data
type: plain_text
items:
type: object
body_part:
type: string
description: Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
example: worker.js
compatibility_date:
type: string
description: Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
example: '2023-07-25'
compatibility_flags:
type: array
description: Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`.
items:
type: string
keep_bindings:
type: array
description: List of binding types to keep from previous_upload.
items:
type: string
logpush:
$ref: '#/components/schemas/workers_logpush'
main_module:
type: string
description: Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
example: worker.js
migrations:
oneOf:
- $ref: '#/components/schemas/workers_single_step_migrations'
- $ref: '#/components/schemas/workers_stepped_migrations'
description: Migrations to apply for Durable Objects associated with this Worker.
placement:
$ref: '#/components/schemas/workers_placement_config'
tags:
type: array
description: List of strings to use as tags for this Worker
items:
type: string
tail_consumers:
$ref: '#/components/schemas/workers_tail_consumers'
usage_model:
type: string
description: Usage model to apply to invocations.
enum:
- bundled
- unbound
version_tags:
type: object
description: Key-value pairs to use as tags for this version of this Worker
- type: object
properties:
message:
type: string
description: Rollback message to be associated with this deployment. Only parsed when query param `"rollback_to"` is present.
encoding:
:
contentType: application/javascript+module, text/javascript+module, application/javascript, text/javascript, application/wasm, text/plain, application/octet-stream
text/javascript:
schema:
type: string
description: Raw javascript content comprising a Worker. Must be in service worker syntax.
example: addEventListener('fetch', (event) => event.respondWith(new Response('OK')))