openapi: 3.2.0
info:
description: Welcome to Cloudflare's API documentation site.
license:
name: BSD-3-Clause
url: https://opensource.org/licenses/BSD-3-Clause
title: Cloudflare Stream Videos API
version: 4.0.0
servers:
- description: Client API
url: https://api.cloudflare.com/client/v4
security:
- api_email: []
api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Stream Videos
paths:
/accounts/{account_id}/stream:
get:
operationId: stream-videos-list-videos
summary: List videos
description: Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.
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: video_name
in: query
schema:
$ref: '#/components/schemas/stream_video_name'
- 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'
- name: id
in: query
description: Filter by video ID(s). Can be a single ID or a comma-separated list of IDs.
schema:
type: string
example: ea95132c15732412d22c1476fa83f27a
- name: name
in: query
description: Filter by video name/UID(s). Can be a single name or a comma-separated list.
schema:
type: string
- name: live_input_id
in: query
description: Filter by live input ID to find videos associated with a specific live stream.
schema:
type: string
- name: before
in: query
description: Alias for 'end'. Returns videos created before this date/time (RFC 3339 format).
schema:
type: string
format: date-time
- name: after
in: query
description: Alias for 'start'. Returns videos created after this date/time (RFC 3339 format).
schema:
type: string
format: date-time
- name: limit
in: query
description: Maximum number of videos to return (default 1000, max 1000).
schema:
type: integer
maximum: 1000
minimum: 1
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: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
- Stream Read
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: list
post:
operationId: stream-videos-initiate-video-uploads-using-tus
summary: 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.
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'
- name: direct_user
in: query
schema:
$ref: '#/components/schemas/stream_direct_user'
responses:
'201':
description: Initiate video uploads using TUS response. Returns a 201 Created status with Location header for TUS uploads.
headers:
Location:
description: The URL where the upload should be sent.
schema:
type: string
Stream-Media-ID:
description: The unique identifier for the video being uploaded.
schema:
type: string
Tus-Resumable:
description: The TUS protocol version.
schema:
type: string
example: 1.0.0
4XX:
description: Initiate video uploads using TUS response failure.
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: create
/accounts/{account_id}/stream/copy:
post:
operationId: stream-videos-upload-videos-from-a-url
summary: Upload videos from a URL
description: Uploads a video to Stream from a provided 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'
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: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: copy
/accounts/{account_id}/stream/direct_upload:
post:
operationId: stream-videos-upload-videos-via-direct-upload-ur-ls
summary: Upload videos via direct upload URLs
description: Creates a direct upload endpoint that allows an end-user to upload a video without an API key.
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: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos.direct-upload
x-fern-sdk-method-name: create
/accounts/{account_id}/stream/storage-usage:
get:
operationId: stream-videos-storage-usage
summary: Storage use
description: Returns information about an account's storage use.
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: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
- Stream Read
x-fern-availability: generally-available
x-fern-sdk-group-name: stream
x-fern-sdk-method-name: storage-usage
/accounts/{account_id}/stream/{identifier}:
delete:
operationId: stream-videos-delete-video
summary: Delete video
description: Deletes a video and its copies from Cloudflare Stream.
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: Delete video response.
4XX:
description: Delete video response failure.
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: delete
x-forge-require-confirmation: Permanently delete this video?
get:
operationId: stream-videos-retrieve-video-details
summary: Retrieve video details
description: Fetches details for a single 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'
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: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
- Stream Read
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: get
post:
operationId: stream-videos-update-video-details
summary: Edit video details
description: Edit details for a single 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:
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: []
tags:
- Stream Videos
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: edit
/accounts/{account_id}/stream/{identifier}/embed:
get:
operationId: stream-videos-retreieve-embed-code-html
summary: 'Deprecated: Retrieve legacy embed code HTML'
description: Fetches the legacy 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.
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 embed Code HTML response.
content:
text/html:
schema:
type: string
example:
4XX:
description: Retrieve embed Code HTML response failure.
content:
application/json:
schema:
$ref: '#/components/schemas/stream_api-response-common-failure'
security:
- api_email: []
api_key: []
api_token: []
tags:
- Stream Videos
x-api-token-group:
- Stream Write
- Stream Read
x-fern-availability: deprecated
x-fern-sdk-group-name: stream.videos
x-fern-sdk-method-name: embed
x-forge-hidden: true
/accounts/{account_id}/stream/{identifier}/token:
post:
operationId: stream-videos-create-signed-url-tokens-for-videos
summary: 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.
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: []
tags:
- Stream Videos
x-fern-availability: generally-available
x-fern-sdk-group-name: stream.videos.token
x-fern-sdk-method-name: create
x-forge-require-confirmation: Provision temporary token? For use at scale, consider creating a signing key instead.
components:
schemas:
stream_video_response_single:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
$ref: '#/components/schemas/stream_videos'
type: object
stream_requireSignedURLs:
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.
type: boolean
example: true
default: false
x-auditable: true
stream_video_response_collection:
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/stream_videos'
type: object
- properties:
range:
description: The total number of remaining videos based on cursor position.
type: integer
example: 1000
total:
description: The total number of videos that match the provided filters.
type: integer
example: 35586
type: object
stream_readyToStream:
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.
type: boolean
example: true
x-auditable: true
stream_start:
description: Lists videos created after the specified date.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
stream_video_name:
description: Provides a fast, exact string match on the `name` key in the `meta` field.
type: string
example: puppy.mp4
x-auditable: true
stream_accessRules:
description: Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.
type: object
properties:
action:
description: The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.
type: string
example: allow
enum:
- allow
- block
x-auditable: true
country:
description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.
type: array
items:
type: string
x-auditable: true
ip:
description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests.
type: array
items:
type: string
x-auditable: true
type:
description: Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.
type: string
example: ip.src
enum:
- any
- ip.src
- ip.geoip.country
x-auditable: true
stream_type:
description: Specifies whether the video is `vod` or `live`.
type: string
example: live
x-auditable: true
stream_preview:
description: The video's preview page URI. This field is omitted until encoding is complete.
type: string
format: uri
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch
x-auditable: true
stream_pctComplete:
description: Indicates the progress as a percentage between 0 and 100.
type: string
example: '45'
x-auditable: true
stream_identifier:
description: A Cloudflare-generated unique identifier for a media item.
type: string
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
x-auditable: true
stream_asc:
description: Lists videos in ascending order of creation.
type: boolean
example: true
default: false
stream_allowedOrigins:
description: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
type: array
items:
type: string
x-auditable: true
example:
- example.com
stream_thumbnail_url:
description: The media item's thumbnail URI. This field is omitted until encoding is complete.
type: string
format: uri
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg
x-auditable: true
stream_thumbnailTimestampPct:
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.
type: number
example: 0.529241
default: 0
maximum: 1
minimum: 0
x-auditable: true
stream_messages:
type: array
items:
properties:
code:
type: integer
minimum: 1000
documentation_url:
type: string
message:
type: string
source:
type: object
properties:
pointer:
type: string
required:
- code
- message
type: object
uniqueItems: true
example: []
stream_readyToStreamAt:
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.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_api-response-common:
type: object
properties:
errors:
$ref: '#/components/schemas/stream_messages'
messages:
$ref: '#/components/schemas/stream_messages'
success:
description: Whether the API call was successful.
type: boolean
example: true
enum:
- true
required:
- success
- errors
- messages
stream_input:
type: object
properties:
height:
description: The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.
type: integer
x-auditable: true
width:
description: The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.
type: integer
x-auditable: true
stream_errorReasonText:
description: Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.
type: string
example: The file was not recognized as a valid video file.
x-auditable: true
stream_media_metadata:
description: A user modifiable key-value store used to reference other systems of record for managing videos.
type: object
example:
name: video12345.mp4
stream_downloadedFrom:
description: The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
type: string
example: https://company.com/logo.png
x-auditable: true
stream_maxDurationSeconds:
description: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown.
type: integer
maximum: 36000
minimum: 1
x-auditable: true
stream_opacity:
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.
type: number
example: 0.75
default: 1
maximum: 1
minimum: 0
x-auditable: true
stream_watermark_identifier:
description: The unique identifier for a watermark profile.
type: string
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
x-auditable: true
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'
stream_video_copy_request:
description: Copy upload request. Provide `input` (preferred) or `url` (deprecated).
type: object
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
creator:
$ref: '#/components/schemas/stream_creator'
input:
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. This is the preferred field over `url`.
type: string
format: uri
example: https://example.com/myvideo.mp4
meta:
$ref: '#/components/schemas/stream_media_metadata'
name:
description: A video's name. Used for legacy compatibility.
type: string
example: myvideo.mp4
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
url:
description: A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file. This field is deprecated in favor of `input`.
type: string
format: uri
example: https://example.com/myvideo.mp4
watermark:
$ref: '#/components/schemas/stream_watermark_at_upload'
anyOf:
- required:
- input
type: object
- required:
- url
type: object
stream_direct_upload_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
properties:
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
uid:
$ref: '#/components/schemas/stream_identifier'
uploadURL:
description: The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.
type: string
example: www.example.com/samplepath
watermark:
$ref: '#/components/schemas/stream_watermarks'
type: object
stream_storage_use_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
properties:
creator:
$ref: '#/components/schemas/stream_creator'
totalStorageMinutes:
description: The total minutes of video content stored in the account. May contain decimal values.
type: number
format: float
totalStorageMinutesLimit:
description: The storage capacity alloted for the account.
type: integer
videoCount:
description: The total count of videos associated with the account.
type: integer
type: object
stream_modified:
description: The date and time the media item was last modified.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_search:
description: Provides a partial word match of the `name` key in the `meta` field. Slow for medium to large video libraries. May be unavailable for very large libraries.
type: string
example: puppy.mp4
x-auditable: true
stream_liveInput:
description: The live input ID used to upload a video with Stream Live.
type: string
example: fc0a8dc887b16759bfd9ad922230a014
maxLength: 32
x-auditable: true
x-fern-type-name: LiveInputId
stream_include_counts:
description: Includes the total number of videos associated with the submitted query parameters.
type: boolean
example: true
default: false
stream_watermark_at_upload:
type: object
properties:
uid:
description: The unique identifier for the watermark profile.
type: string
example: ea95132c15732412d22c1476fa83f27a
maxLength: 32
x-auditable: true
stream_creator:
description: A user-defined identifier for the media creator.
type: string
example: creator-id_abcde12345
maxLength: 64
x-auditable: true
stream_api-response-single:
type: object
allOf:
- $ref: '#/components/schemas/stream_api-response-common'
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'
publicDetails:
description: Public details for the video including title, share link, channel link, and logo.
type: object
properties:
channel_link:
type:
- string
- 'null'
logo:
type:
- string
- 'null'
share_link:
type:
- string
- 'null'
title:
type:
- string
- 'null'
requireSignedURLs:
$ref: '#/components/schemas/stream_requireSignedURLs'
scheduledDeletion:
$ref: '#/components/schemas/stream_scheduledDeletion'
thumbnailTimestampPct:
$ref: '#/components/schemas/stream_thumbnailTimestampPct'
uid:
description: The unique identifier for the video. Can be used to verify the video being updated.
type: string
example: ea95132c15732412d22c1476fa83f27a
uploadExpiry:
$ref: '#/components/schemas/stream_oneTimeUploadExpiry'
stream_uploaded:
description: The date and time the media item was uploaded.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_signed_token_request:
type: object
properties:
accessRules:
description: The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.
type: array
items:
$ref: '#/components/schemas/stream_accessRules'
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
downloadable:
description: The optional boolean value that enables using signed tokens to access MP4 download links for a video.
type: boolean
default: false
x-auditable: true
exp:
description: The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.
type: integer
flags:
description: Optional flags for the signed token.
type: object
properties:
original:
description: Whether to return the original video without transformations.
type: boolean
default: false
id:
description: The optional ID of a Stream signing key. If present, the `pem` field is also required.
type: string
example: ab0d4ef71g4425f8dcba9041231813000
x-auditable: true
nbf:
description: The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.
type: integer
x-auditable: true
pem:
description: The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.
type: string
example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
x-sensitive: true
stream_direct_upload_request:
type: object
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
creator:
$ref: '#/components/schemas/stream_creator'
expiry:
description: The date and time after upload when videos will not be accepted.
type: string
format: date-time
example: '2021-01-02T02:20:00Z'
default: Now + 30 minutes
x-auditable: true
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'
required:
- maxDurationSeconds
stream_direct_user:
description: Provisions a URL to let your end users upload videos directly to Cloudflare Stream without exposing your API token to clients.
type: boolean
example: true
default: false
x-auditable: true
stream_playback:
type: object
properties:
dash:
description: DASH Media Presentation Description for the video.
type: string
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd
x-auditable: true
hls:
description: The HLS manifest for the video.
type: string
example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8
x-auditable: true
stream_oneTimeUploadExpiry:
description: The date and time when the video upload URL is no longer valid for direct user uploads.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_media_state:
description: Specifies the processing status for all quality levels for a video.
type: string
example: inprogress
enum:
- pendingupload
- downloading
- queued
- inprogress
- ready
- error
- live-inprogress
x-auditable: true
stream_upload_metadata:
description: 'Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded.
Supported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`, `maxdurationseconds`.'
type: string
example: name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20=
x-auditable: true
stream_api-response-common-failure:
type: object
properties:
errors:
example:
- code: 7003
message: No route for the URI
allOf:
- $ref: '#/components/schemas/stream_messages'
minLength: 1
messages:
example: []
allOf:
- $ref: '#/components/schemas/stream_messages'
result:
type:
- object
- 'null'
enum:
- null
success:
description: Whether the API call was successful.
type: boolean
example: false
enum:
- false
required:
- success
- errors
- messages
- result
stream_scale:
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.
type: number
example: 0.1
default: 0.15
maximum: 1
minimum: 0
x-auditable: true
stream_watermark_created:
description: The date and a time a watermark profile was created.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_padding:
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.
type: number
example: 0.1
default: 0.05
maximum: 1
minimum: 0
x-auditable: true
stream_scheduledDeletion:
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.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_name:
description: A short description of the watermark profile.
type: string
example: Marketing Videos
default: ''
x-auditable: true
stream_watermark_size:
description: The size of the image in bytes.
type: number
example: 29472
x-auditable: true
stream_width:
description: The width of the image in pixels.
type: integer
x-auditable: true
stream_duration:
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.
type: number
x-auditable: true
stream_upload_length:
description: Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
type: integer
minimum: 0
x-auditable: true
stream_signed_token_response:
allOf:
- $ref: '#/components/schemas/stream_api-response-single'
- properties:
result:
type: object
properties:
token:
description: The signed token used with the signed URLs feature.
type: string
example: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A
x-sensitive: true
type: object
stream_size:
description: The size of the media item in bytes.
type: number
example: 4190963
x-auditable: true
stream_created:
description: The date and time the media item was created.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
x-auditable: true
stream_videos:
type: object
properties:
allowedOrigins:
$ref: '#/components/schemas/stream_allowedOrigins'
clippedFrom:
description: The unique identifier of the source video this video was clipped from.
type: string
example: ea95132c15732412d22c1476fa83f27a
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'
maxSizeBytes:
description: The maximum size in bytes for the video upload.
type: integer
format: int64
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'
publicDetails:
description: Public details for the video including title, share link, channel link, and logo.
type: object
properties:
channel_link:
type:
- string
- 'null'
logo:
type:
- string
- 'null'
media_id:
type: integer
share_link:
type:
- string
- 'null'
title:
type:
- string
- 'null'
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'
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_height:
description: The height of the image in pixels.
type: integer
x-auditable: true
stream_end:
description: Lists videos created before the specified date.
type: string
format: date-time
example: '2014-01-02T02:20:00Z'
stream_position:
description: 'The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.'
type: string
example: center
default: upperRight
x-auditable: true
stream_tus_resumable:
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.'
type: string
example: 1.0.0
enum:
- 1.0.0
x-auditable: true
stream_account_identifier:
description: The account identifier tag.
type: string
example: 023e105f4ecef8ad9ca31a8372d0c353
maxLength: 32
x-auditable: true
stream_errorReasonCode:
description: Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.
type: string
example: ERR_NON_VIDEO
x-auditable: true
securitySchemes:
api_email:
in: header
name: X-Auth-Email
type: apiKey
api_key:
in: header
name: X-Auth-Key
type: apiKey
api_token:
scheme: bearer
type: http
user_service_key:
in: header
name: X-Auth-User-Service-Key
type: apiKey
externalDocs:
description: Cloudflare Radar Documentation
url: https://developers.cloudflare.com/radar/
x-forge-commands:
abuse-reports:
description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites
groups:
appeals:
description: Appeal eligibility for abuse reports
emails:
description: Emails sent for abuse reports
mitigations:
description: Mitigation actions taken in response to abuse reports
accounts:
description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account
groups:
applications:
description: Applications operations
categories:
description: Categories operations
organizations:
description: Move accounts between organizations
profile:
description: View and manage the profile for a Cloudflare account
roles:
description: View the roles available for assigning to account members, each defining a set of permissions
subscriptions:
description: View and manage plan subscriptions attached to this account
tokens:
description: Create and manage scoped API tokens for programmatic access to the Cloudflare API
ai-gateway:
description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more
groups:
custom-domains:
description: Manage custom hostnames that route requests through an AI Gateway
custom-providers:
description: Manage account-level custom AI providers and their endpoint settings
datasets:
description: 'Deprecated: manage filtered collections of gateway logs used by evaluations'
dynamic-routing:
description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments
dynamic-routing.deployments:
description: Deploy dynamic route versions and view deployment history
dynamic-routing.versions:
description: Create and inspect saved versions of a dynamic route
evaluation-types:
description: 'Deprecated: list the evaluator types that evaluations can use'
evaluations:
description: 'Deprecated: score the logs in a dataset with selected evaluator types'
gateways:
description: Create and configure AI Gateways for an account
gateways.providers:
description: Store and rotate upstream AI provider keys for a gateway
logs:
description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs
ai-search:
description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions'
groups:
items:
description: Content indexed by AI Search instances
jobs:
description: Indexing job lifecycle for AI Search instances
namespace:
description: Logical groupings for organizing AI Search instances
tokens:
description: Credentials used by AI Search instances
ai-security:
description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications
groups:
custom-topics:
description: Organization-specific topic categories used by AI Security for Apps content detection
analytics:
description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics
groups:
colo:
description: Per-data-center (colo) traffic analytics breakdown for the zone
dashboard:
description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views
latency:
description: Argo Smart Routing latency analytics showing time-to-first-byte improvements
argo:
description: Network optimization features that speed up and improve reliability of traffic to your origins
groups:
smart-routing:
description: Route traffic through the fastest network paths to your origin using real-time latency data
tiered-caching:
description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin
basin-catalog:
description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
groups:
credentials:
description: Catalog access credentials for external query engines (Spark, Trino, etc.)
maintenance-configs:
description: Table maintenance settings — compaction schedules and snapshot expiration policies
namespaces:
description: Logical namespaces that group related tables within the data catalog
namespaces.tables:
description: Tables within catalog namespaces
namespaces.tables.maintenance-configs:
description: Table-level maintenance configurations and operations
namespaces.tables.maintenance-runs:
description: History of maintenance runs performed on tables
billing:
description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services
groups:
profiles:
description: Billing profile with payment method, address, and invoice preferences
usage:
description: Metered usage data for billed services — requests, bandwidth, and feature consumption
botnet-feed:
description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure
groups:
asn:
description: ASN-level botnet activity data showing networks with known C2 infrastructure
configs:
description: Botnet feed subscription configuration and notification preferences
builds:
description: Build and deploy Workers from connected repositories, then inspect build status and logs.
groups:
deploy-hooks:
description: Manage branch-specific HTTP hooks that start builds.
limits:
description: View build-minute availability and refresh information.
logs:
description: Retrieve build logs.
repos:
description: Manage source repository connections for Workers Builds.
tokens:
description: Manage credentials used by Workers Builds to deploy Workers.
triggers:
description: Configure how repository changes build and deploy Workers.
versions:
description: Find builds associated with Worker versions.
workers:
description: Manage repository-backed build configuration for Workers.
cache:
description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving
groups:
origin-cloud-regions:
description: Manage Origin Cloud Regions routing and failover configurations
settings:
description: Configure Cache Reserve, tiered caching, and variant serving
settings.regional-tiered-cache:
description: Restrict tiered cache topology to data centers within a specific geographic region
settings.reserve:
description: Persistent storage tier that keeps cached assets even after eviction from edge caches
settings.smart-tiered-cache:
description: Automatically determine the best upper-tier data centers for tiered cache topology
settings.variants:
description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.)
client-side-security:
description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks
groups:
connections:
description: Third-party connections made by scripts on your pages — track data exfiltration risks
cookies:
description: Cookies set by your pages with classification and same-site attribute tracking
policies:
description: Content Security Policies that control which scripts and connections are allowed on your pages
scripts:
description: JavaScript files detected on your pages with change tracking and malicious code detection
settings:
description: Fine tune Client-Side Security behaviors
cloud-connector:
description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers
groups:
rules:
description: Routing rules that map request patterns to cloud provider endpoints
cloudforce-one:
description: Detection rule management APIs
groups:
binary-storage:
description: Upload and retrieve malware samples and suspicious binaries for analysis
requests:
description: Additional request operations — priority listing and asset creation
rules:
description: Rule management operations
groups:
approvals:
description: Approval workflow operations
email:
description: Email rule operations
exemptions:
description: Exemption rule operations
managed:
description: Managed rule operations
stats:
description: Rule statistics operations
tree:
description: Rule navigation tree operations
scans:
description: Scan URLs, IPs, and domains for threat intelligence indicators
containers:
description: Deploy and manage Containers applications on Cloudflare's global network
groups:
applications:
description: Manage Containers applications
applications.instances:
description: Inspect Containers instances belonging to applications
applications.rollouts:
description: Manage rollouts for scheduler-backed applications
applications.versions:
description: Inspect versions of scheduler-backed applications
registries:
description: Manage Containers image registries
registries.credentials:
description: Generate image registry credentials
content-scan:
description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads
groups:
expressions:
description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own
custom-pages:
description: Manage custom error and challenge pages and their assets for accounts and zones
groups:
account-custom-pages:
description: Manage account-level custom pages
account-custom-pages.preview-tokens:
description: Preview tokens for account-level custom pages
assets:
description: Manage account- and zone-level custom assets
zone-custom-pages:
description: Manage zone-level custom pages
zone-custom-pages.preview-tokens:
description: Preview tokens for zone-level custom pages
d1:
description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access.
groups:
time-travel:
description: use specific point-in-time backups of your D1 database
x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel
diagnostics:
description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks
groups:
endpoint-healthchecks:
description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks
traceroutes:
description: Run traceroutes from Cloudflare data centers to diagnose network path issues
email-routing:
description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records
groups:
addresses:
description: Verified destination email addresses that can receive forwarded mail
dns:
description: Inspect or unlock the DNS records required by Email Routing
rules:
description: Match incoming email addresses and forward messages to destination mailboxes or Workers
settings:
description: Inspect and update Email Routing settings
email-security:
description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing
groups:
analytics:
description: Analytics and reporting — monthly report and per-day breakdowns of threat activity
bulk-actions:
description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs
investigate:
description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions
phishguard:
description: PhishGuard user-reported phishing reports — view detected threats for a date range
settings:
description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling
submissions:
description: Reclassify submissions — track user and team reports of false positives and missed detections
email-sending:
description: Send transactional email and manage sending subdomains and their DNS configuration
groups:
limits:
description: Inspect account-level sending quotas and current usage
subdomains:
description: Configure sending subdomains and keep their DNS records healthy
suppressions:
description: Prevent delivery to suppressed addresses and manage the account suppression list
filters:
description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations
firewall:
description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages
groups:
access-rules:
description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone
lockdowns:
description: Zone lockdown rules that restrict access to URLs by IP address or range
rules:
description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations
ua-rules:
description: Block or challenge requests based on the User-Agent header string
waf:
description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations
zone-access-rules:
description: Zone-scoped IP access rules for blocking or allowing traffic
google-tag-gateway:
description: Google Tag Gateway operations
groups:
config:
description: Google Tag Gateway config operations
healthchecks:
description: Standalone health checks that monitor origin server availability from Cloudflare's edge
groups:
previews:
description: Test a health check configuration before deploying it to production
hyperdrive:
description: Accelerate access to existing databases by caching queries and pooling connections at the edge
iam:
description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors
groups:
permission-groups:
description: View the permission groups that can be assigned to API tokens and policies
resource-groups:
description: Define scopes that limit which account resources a policy or token can access
sso:
description: Configure single sign-on connectors to authenticate account members through an external identity provider
user-groups:
description: Organize account members into groups for easier permission assignment
images:
description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads
groups:
flows:
description: Zone-level transformation flows that control how images are resized and optimized on delivery
import:
description: Import images from S3
keys:
description: Manage signing keys for generating private image URLs
variants:
description: Manage named resize variants for transforming images on delivery
intel:
description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds
groups:
asn:
description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems
attack-surface-report:
description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping
dns:
description: Passive DNS data showing historical DNS resolution records for domains
domain-history:
description: Historical domain registration and categorization changes over time
domains:
description: Domain intelligence — risk scores, categories, and associated infrastructure
indicator-feeds:
description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs
ip-lists:
description: Curated IP lists used for threat detection and policy enforcement
ips:
description: IP address intelligence — geolocation, risk assessment, and hosting provider details
miscategorizations:
description: Report and track domain miscategorization corrections
whois:
description: WHOIS registration data for domains including registrant, registrar, and nameservers
k2:
description: Durable, ordered event streams that you produce records to and consume from with subscriptions
groups:
streams:
description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records
streams.subscriptions:
description: Subscriptions that consume a K2 stream, with committed-position lag
leaked-credential-checks:
description: Detect compromised credentials in login requests by checking against known breach databases
groups:
detections:
description: Custom detection locations that tell the WAF where to find usernames and passwords in requests
load-balancers:
description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover
groups:
monitor-groups:
description: Group monitors together for shared configuration and bulk management
monitor-groups.references:
description: List references to monitor groups used by load balancer pools
monitors:
description: Health check configurations that probe origin servers and determine pool availability
monitors.previews:
description: Health check configurations that probe origin servers and determine pool availability
monitors.references:
description: Health check configurations that probe origin servers and determine pool availability
pools:
description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
pools.health:
description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
pools.references:
description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences
previews:
description: Preview the result of a health check monitor configuration before applying it
regions:
description: Geographic regions used for regional pool steering and traffic policies
searches:
description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference
logs:
description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields
groups:
control:
description: Log control operations
received:
description: Received log operations
magic-network-monitoring:
description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion
groups:
configs:
description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings
rules:
description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements
vpc-flows:
description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection
magic-transit:
description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures
groups:
advanced-dns-protection:
description: Advanced Dns Protection operations
advanced-tcp-protection:
description: Advanced Tcp Protection operations
apps:
description: Application-aware traffic policies for Magic WAN that steer traffic by app type
bgp-filter-profiles:
description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels
bgp-settings:
description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels
cf-interconnects:
description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering
gre-tunnels:
description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit
ipsec-tunnels:
description: IPsec tunnel endpoints with pre-shared key management for encrypted transit
pcaps:
description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels
routes:
description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels
sites:
description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config
mcp:
description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls
groups:
portals:
description: Manage MCP portals, attached servers, and Code Mode settings
servers:
description: Manage upstream MCP servers, credentials, capabilities, and sync state
network-interconnects:
description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network
groups:
cnis:
description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare
interconnects:
description: Physical cross-connect and partner interconnect sessions with LOA and status tracking
settings:
description: Account-level interconnect settings and default configurations
slots:
description: Available interconnect facility slots showing port capacity at Cloudflare data centers
organizations:
description: Multi-user organizations that group accounts, members, and shared settings under a single entity
groups:
account-organizations:
description: List organizations associated with a specific account
accounts:
description: Accounts operations
members:
description: Members operations
members-batch-create:
description: Members Batch Create operations
organization-profile:
description: View and update the public profile information for an organization
shares:
description: Shares operations
origin-post-quantum-encryption:
description: Enable post-quantum key exchange for connections between Cloudflare and your origin server
pages:
description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains
groups:
projects:
description: Pages projects, deployments, build logs, and custom domain bindings
pipelines:
description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time
groups:
sinks:
description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage
streams:
description: Inbound data streams that feed events into a pipeline for processing
precursor:
description: Precursor settings for a zone
queues:
description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale
groups:
consumers:
description: Workers that automatically receive and process messages from a queue
messages:
description: Push messages to a queue and pull or acknowledge them from consumers
purge:
description: Remove all pending messages from a queue
subscriptions:
description: Manage queue subscriptions for event-driven message routing
r2:
description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration
groups:
buckets:
description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks
buckets.jobs:
description: Create and inspect background jobs for an R2 bucket
buckets.local-uploads:
description: R2 bucket local upload configuration
super-slurper:
description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs
temporary-credentials:
description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations
r2-data-catalog:
description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines
groups:
credentials:
description: Catalog access credentials for external query engines (Spark, Trino, etc.)
maintenance-configs:
description: Table maintenance settings — compaction schedules and snapshot expiration policies
namespaces:
description: Logical namespaces that group related tables within the data catalog
namespaces.tables:
description: Tables within catalog namespaces
namespaces.tables.maintenance-configs:
description: Table-level maintenance configurations and operations
namespaces.tables.maintenance-runs:
description: History of maintenance runs performed on tables
radar:
description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights
groups:
agent-readiness:
description: Agent readiness summary statistics across the Cloudflare network
ai:
description: AI inference trends and model usage statistics across the Cloudflare network
annotations:
description: Radar annotations marking significant Internet events (outages, cable cuts, etc.)
as112:
description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space
attacks:
description: DDoS and application-layer attack trends, vectors, and target analysis
bgp:
description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events
bots:
description: Internet-wide bot traffic trends, categories, and distribution statistics
ct:
description: Certificate Transparency log monitoring and newly-issued certificate discovery
datasets:
description: Downloadable Radar datasets for offline analysis and research
dns:
description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption
email:
description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics
entities:
description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries
geolocations:
description: Geographic location metadata used for regional traffic analysis
http:
description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution
leaked-credentials:
description: Leaked credential detection trends and exposure statistics
netflows:
description: Network-layer traffic flow data and volumetric trend analysis
origins:
description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics
post-quantum:
description: Post-quantum encryption adoption and deployment trends across the Internet
quality:
description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN
ranking:
description: Top domain rankings based on DNS query popularity across the Cloudflare network
robots-txt:
description: Robots.txt adoption and crawler directive trends across the web
search:
description: Search Radar data across IPs, ASNs, domains, and locations
tcp-resets-timeouts:
description: TCP connection reset and timeout statistics indicating network health issues
tlds:
description: Top-level domain (TLD) metadata and performance trends
traffic-anomalies:
description: Detected traffic anomalies and unusual patterns in Internet traffic flows
verified-bots:
description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns
rate-limits:
description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations
realtime:
description: Real-time audio, video, and data services on Cloudflare's global network
groups:
kit:
description: SDK-backed meetings, participants, recordings, livestreams, and webhooks
kit.analytics:
description: Usage and livestream analytics for RealtimeKit applications
kit.analytics.livestreams:
description: Livestream analytics for RealtimeKit applications
kit.analytics.livestreams.daily:
description: Daily livestream analytics for RealtimeKit applications
kit.analytics.usage:
description: Usage analytics for RealtimeKit applications
kit.apps:
description: RealtimeKit applications that group meetings, sessions, and configuration
kit.livestreams:
description: Independent and meeting-based livestreams and their sessions
kit.livestreams.sessions:
description: Sessions for RealtimeKit livestreams
kit.meetings:
description: Meetings, participants, access tokens, and meeting livestreams
kit.meetings.active:
description: Live meeting state and participant controls
kit.meetings.active.polls:
description: Polls for active meeting sessions
kit.meetings.livestream:
description: Livestream operations associated with RealtimeKit meetings
kit.meetings.participants:
description: Participants in RealtimeKit meetings
kit.meetings.participants.tokens:
description: Access tokens for RealtimeKit meeting participants
kit.presets:
description: Reusable meeting configuration for media, permissions, and interface behavior
kit.recordings:
description: Meeting and participant-track recordings and recording controls
kit.recordings.active:
description: Active recordings for RealtimeKit meetings
kit.recordings.tracks:
description: Participant-track recordings for RealtimeKit meetings
kit.sessions:
description: Historical session data, participants, chat, transcripts, and summaries
kit.sessions.chat:
description: Chat messages from historical RealtimeKit sessions
kit.sessions.livestreams:
description: Livestreams associated with historical RealtimeKit sessions
kit.sessions.participants:
description: Participants in historical RealtimeKit sessions
kit.sessions.peers:
description: Peer details from historical RealtimeKit sessions
kit.sessions.summaries:
description: Summaries of historical RealtimeKit sessions
kit.sessions.transcripts:
description: Transcripts from historical RealtimeKit sessions
kit.webhooks:
description: Webhook endpoints and supported events for RealtimeKit notifications
kit.webhooks.events:
description: Supported events for RealtimeKit webhooks
moq:
description: MoQ relays for publishing and subscribing to media streams
moq.relays:
description: Relays are isolated MoQ scopes that carry media between publishers and subscribers
moq.relays.tokens:
description: Tokens that authorize publishers and subscribers to connect to a relay
sfu:
description: SFU apps that route WebRTC media and data between participants
sfu.apps:
description: SFU application namespaces for sessions and tracks
turn:
description: TURN keys that help clients traverse NATs and firewalls
turn.keys:
description: Keys used to generate short-lived TURN credentials
request-tracers:
description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline
groups:
traces:
description: Simulate request processing to debug rule matches, transforms, and routing decisions
resource-sharing:
description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls
groups:
recipients:
description: Update share recipients
resources:
description: Individual resources (zones, configs) that have been shared with recipients
rules:
description: Resources used by Cloudflare rules and rulesets
groups:
lists:
description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions
rum:
description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics
groups:
rules:
description: Rules that control which pages and paths are tracked by Web Analytics
site-info:
description: Web Analytics sites — register domains and get the JavaScript beacon snippet
scim:
description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account
groups:
groups:
description: Groups operations
resource-types:
description: Resource Types operations
schemas:
description: Schemas operations
service-provider-config:
description: Service Provider Config operations
users:
description: Users operations
secrets-store:
description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products
groups:
quota:
description: Account quota limits for secrets stores, secrets count, and storage capacity
secrets:
description: Encrypted key-value secrets within a store. Pass --store-id to scope.
stores:
description: Secret stores that hold encrypted key-value secrets accessible by Workers and services
security-center:
description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities
groups:
insights:
description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc.
zone-insights:
description: Zone-scoped security insights — counts by class, severity, type, and dismissal
security-txt:
description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities
smart-shield:
description: Smart Shield settings, health checks, and cache reserve management
groups:
cache-reserve-clear:
description: Cache Reserve Clear operations
health-checks:
description: Health checks operations
spectrum:
description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation
groups:
analytics:
description: Real-time and historical connection analytics for Spectrum applications
apps:
description: Spectrum application configurations that map protocols and ports to origin servers
speed:
description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests
groups:
availabilities:
description: Check which speed test regions and configurations are available for your zone
pages:
description: Tested pages with their performance history, trends, and individual test results
schedule:
description: Scheduled recurring speed tests that automatically run at regular intervals
ssl:
description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations
groups:
automatic-upgrader:
description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings
recommendations:
description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration
stream:
description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale
groups:
audio-tracks:
description: Add, edit, or remove additional audio tracks on a video
captions:
description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages
clip:
description: Create a new video clip from an existing video by specifying start and end times
copy:
description: Import a video from a URL into Stream for processing and delivery
direct-upload:
description: Generate a tokenized URL that lets end-users upload video directly to Stream
downloads:
description: Create downloadable MP4 renditions of a video for offline viewing
embed:
description: Retrieve the HTML embed code snippet for a video
keys:
description: Signing keys used to generate short-lived signed URLs for private video playback
live-inputs:
description: Enable and disable live input streams
token:
description: Generate short-lived signed URL tokens for secure private video playback
typed-downloads:
description: Type-specific stream download creation and deletion
videos:
description: Aggregate video storage usage statistics for the account
watermarks:
description: Watermark profiles that overlay an image on every video in the account
webhooks:
description: Webhook notifications for video lifecycle events (ready, error, etc.)
tenants:
description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships
groups:
account-types:
description: Account Types operations
accounts:
description: Accounts operations
entitlements:
description: Entitlements operations
memberships:
description: Memberships operations
turnstile:
description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience
groups:
widgets:
description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings
url-scanner:
description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results
groups:
response:
description: Response operations
responses:
description: Raw HTTP response data captured during URL scans
scan:
description: Scan operations
scans:
description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts
user:
description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens
groups:
billing:
description: View billing history and payment profile for your user (deprecated — prefer account-level billing)
firewall:
description: Firewall operations
load-balancers.monitors:
description: Load Balancers operations
load-balancers.monitors.preview:
description: Load Balancers operations
load-balancers.monitors.references:
description: Load Balancers operations
load-balancers.pools:
description: Load Balancers operations
load-balancers.pools.edit.pools:
description: Load Balancers operations
load-balancers.pools.health:
description: Load Balancers operations
load-balancers.pools.preview:
description: Load Balancers operations
load-balancers.pools.references:
description: Load Balancers operations
load-balancers.preview:
description: Load Balancers operations
load-balancing-analytics.events:
description: Load Balancing Analytics operations
subscriptions:
description: View and manage zone-level plan subscriptions owned by your user
tenants:
description: Tenants operations
tokens:
description: Create and manage personal API tokens scoped to your user for programmatic API access
user.analytics:
description: User-level traffic analytics — aggregated totals and timeseries across all zones
vectorize:
description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers
groups:
deprecated-indexes:
description: Deprecated v1 Vectorize index operations
metadata-index:
description: Metadata indexes for filtered vector search
waiting-rooms:
description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages
groups:
account-waiting-rooms:
description: Account-scoped waiting room listing
events:
description: Scheduled events that temporarily override waiting room settings for sales, launches, etc.
page:
description: Custom HTML waiting page templates and preview rendering
rules:
description: Rules that bypass or modify waiting room behavior for specific request patterns
settings:
description: Zone-level waiting room defaults and cookie configuration
statuses:
description: Real-time queue status showing active users, queued users, and estimated wait times
workflows:
description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence
groups:
instances:
description: Workflow instance operations
versions:
description: Workflow version operations
zaraz:
description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS
groups:
config:
description: Full Zaraz configuration including tools, triggers, and variables for the zone
default:
description: Default Zaraz configuration template used as a starting point for new zones
export:
description: Export the current Zaraz configuration as a portable JSON document
history:
description: Configuration version history — browse and restore previous Zaraz configurations
publish:
description: Publish pending Zaraz configuration changes to make them live on the zone
workflow:
description: Workflow state for Zaraz configuration changes (draft vs. published)
zero-trust:
description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation
groups:
dex:
description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics
dlp.custom-prompt-topics:
description: Data Loss Prevention - manage custom prompt topics for AI-based content detection
dlp.data-classes:
description: Data Loss Prevention - manage data classes used to classify sensitive information
dlp.data-tag-categories:
description: Data Loss Prevention - manage categories that organize data tags
dlp.data-tag-category-templates:
description: Data Loss Prevention - browse templates for creating data tag categories
dlp.data-tags:
description: Data Loss Prevention - manage tags used to classify and organize sensitive data
dlp.datasets:
description: Data Loss Prevention - manage datasets, versions, and uploads
dlp.document-fingerprints:
description: Data Loss Prevention - manage document fingerprints for detecting matching documents
dlp.email.account-mapping:
description: Data Loss Prevention - configure account mappings for outbound email scanning
dlp.email.rules:
description: Data Loss Prevention - manage outbound email scanning rules and their priorities
dlp.entries:
description: Data Loss Prevention - list and manage detection entries
dlp.limits:
description: Data Loss Prevention - view account limits and resource quotas
dlp.patterns:
description: Data Loss Prevention - validate regular expressions used for content detection
dlp.profiles:
description: Data Loss Prevention - list and retrieve profiles
dlp.profiles.custom:
description: Data Loss Prevention - manage custom profiles
dlp.profiles.predefined:
description: Data Loss Prevention - manage predefined profiles
dlp.sensitivity-group-templates:
description: Data Loss Prevention - browse templates for creating sensitivity groups
dlp.sensitivity-groups:
description: Data Loss Prevention - manage sensitivity groups and their level ordering
dlp.sensitivity-levels:
description: Data Loss Prevention - manage sensitivity levels within sensitivity groups
dlp.settings:
description: Data Loss Prevention - manage account-level settings
dlp.validators:
description: Data Loss Prevention - list and retrieve content validators
dlp.validators.proximity-words:
description: Data Loss Prevention - manage proximity-word validators
risk-scoring:
description: User Risk Scoring - retrieve and reset user risk scores
risk-scoring.behaviours:
description: User Risk Scoring - manage behaviors used to calculate user risk scores
risk-scoring.integrations:
description: User Risk Scoring - manage integrations that provide risk score signals
risk-scoring.integrations.references:
description: User Risk Scoring - retrieve integrations by external reference
risk-scoring.summary:
description: User Risk Scoring - retrieve account risk score summaries
zones:
description: Zones are domains on Cloudflare — list, create, and configure domain settings
groups:
aegis:
description: Aegis operations
fonts:
description: Fonts operations
origin-h2-max-streams:
description: Origin H2 Max Streams operations
origin-max-http-version:
description: Origin Max Http Version operations
origin-tls-compliance-modes:
description: Manage zone Origin TLS Compliance Modes setting
rum:
description: Rum operations
speed-brain:
description: Speed Brain operations